Skip to content

TestTypeInput

Source code in docs_src/capo_cloudformation/types/test_type_input.py
class TestTypeInput(TypedDict, closed=True):
    arn: NotRequired["capo_cloudformation.types.type_arn.TypeArn"]
    """<p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>"""
    type: NotRequired["capo_cloudformation.types.third_party_type.ThirdPartyType"]
    """<p>The type of the extension to test.</p> <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>"""
    type_name: NotRequired["capo_cloudformation.types.type_name.TypeName"]
    """<p>The name of the extension to test.</p> <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>"""
    version_id: NotRequired["capo_cloudformation.types.type_version_id.TypeVersionId"]
    """<p>The version of the extension to test.</p> <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code> and <code>Type</code>.</p> <p>If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.</p>"""
    log_delivery_bucket: NotRequired["capo_cloudformation.types.s3_bucket.S3Bucket"]
    """<p>The S3 bucket to which CloudFormation delivers the contract test execution logs.</p> <p>CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of <code>PASSED</code> or <code>FAILED</code>.</p> <p>The user calling <code>TestType</code> must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:</p> <ul> <li> <p> <code>GetObject</code> </p> </li> <li> <p> <code>PutObject</code> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>Identity and Access Management User Guide</i>.</p>"""

arn instance-attribute

arn: NotRequired[TypeArn]

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn, or TypeName and Type.

log_delivery_bucket instance-attribute

log_delivery_bucket: NotRequired[S3Bucket]

The S3 bucket to which CloudFormation delivers the contract test execution logs.

CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

  • GetObject

  • PutObject

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

type instance-attribute

type: NotRequired[ThirdPartyType]

The type of the extension to test.

Conditional: You must specify Arn, or TypeName and Type.

type_name instance-attribute

type_name: NotRequired[TypeName]

The name of the extension to test.

Conditional: You must specify Arn, or TypeName and Type.

version_id instance-attribute

version_id: NotRequired[TypeVersionId]

The version of the extension to test.

You can specify the version id with either Arn, or with TypeName and Type.

If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.