CfnPublicTypeVersionProps

class aws_cdk.aws_cloudformation.CfnPublicTypeVersionProps(*, arn=None, log_delivery_bucket=None, public_version_number=None, type=None, type_name=None)

Bases: object

Properties for defining a CfnPublicTypeVersion.

Parameters
  • arn (Optional[str]) – The Amazon Resource Number (ARN) of the extension. Conditional: You must specify Arn , or TypeName and Type .

  • log_delivery_bucket (Optional[str]) – 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 initiating the stack operation 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 AWS Identity and Access Management User Guide .

  • public_version_number (Optional[str]) – The version number to assign to this version of the extension. Use the following format, and adhere to semantic versioning when assigning a version number to your extension: MAJOR.MINOR.PATCH For more information, see Semantic Versioning 2.0.0 . If you do not specify a version number, CloudFormation increments the version number by one minor version release. You cannot specify a version number the first time you publish a type. AWS CloudFormation automatically sets the first version number to be 1.0.0 .

  • type (Optional[str]) – The type of the extension to test. Conditional: You must specify Arn , or TypeName and Type .

  • type_name (Optional[str]) – The name of the extension to test. Conditional: You must specify Arn , or TypeName and Type .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloudformation as cloudformation

cfn_public_type_version_props = cloudformation.CfnPublicTypeVersionProps(
    arn="arn",
    log_delivery_bucket="logDeliveryBucket",
    public_version_number="publicVersionNumber",
    type="type",
    type_name="typeName"
)

Attributes

arn

The Amazon Resource Number (ARN) of the extension.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn

Return type

Optional[str]

log_delivery_bucket

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 initiating the stack operation 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 AWS Identity and Access Management User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket

Return type

Optional[str]

public_version_number

The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0 .

If you do not specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. AWS CloudFormation automatically sets the first version number to be 1.0.0 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber

Return type

Optional[str]

type

The type of the extension to test.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type

Return type

Optional[str]

type_name

The name of the extension to test.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename

Return type

Optional[str]