CfnTypeActivationProps

class aws_cdk.core.CfnTypeActivationProps(*, auto_update=None, execution_role_arn=None, logging_config=None, major_version=None, public_type_arn=None, publisher_id=None, type=None, type_name=None, type_name_alias=None, version_bump=None)

Bases: object

Properties for defining a CfnTypeActivation.

Parameters
  • auto_update (Union[bool, IResolvable, None]) – Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. The default is true .

  • execution_role_arn (Optional[str]) – The name of the IAM execution role to use to activate the extension.

  • logging_config (Union[IResolvable, LoggingConfigProperty, None]) – Specifies logging configuration information for an extension.

  • major_version (Optional[str]) – The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected. You can specify MajorVersion or VersionBump , but not both.

  • public_type_arn (Optional[str]) – The Amazon Resource Number (ARN) of the public extension. Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

  • publisher_id (Optional[str]) – The ID of the extension publisher. Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

  • type (Optional[str]) – The extension type. Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

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

  • type_name_alias (Optional[str]) – An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console. An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.

  • version_bump (Optional[str]) – Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate . - MAJOR : CloudFormation updates the extension to the newest major version, if one is available. - MINOR : CloudFormation updates the extension to the newest minor version, if one is available.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.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.core as cdk

cfn_type_activation_props = cdk.CfnTypeActivationProps(
    auto_update=False,
    execution_role_arn="executionRoleArn",
    logging_config=cdk.CfnTypeActivation.LoggingConfigProperty(
        log_group_name="logGroupName",
        log_role_arn="logRoleArn"
    ),
    major_version="majorVersion",
    public_type_arn="publicTypeArn",
    publisher_id="publisherId",
    type="type",
    type_name="typeName",
    type_name_alias="typeNameAlias",
    version_bump="versionBump"
)

Attributes

auto_update

Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher.

Major versions released by the publisher must be manually updated.

The default is true .

Link

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

Return type

Union[bool, IResolvable, None]

execution_role_arn

The name of the IAM execution role to use to activate the extension.

Link

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

Return type

Optional[str]

logging_config

Specifies logging configuration information for an extension.

Link

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

Return type

Union[IResolvable, LoggingConfigProperty, None]

major_version

The major version of this extension you want to activate, if multiple major versions are available.

The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

You can specify MajorVersion or VersionBump , but not both.

Link

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

Return type

Optional[str]

public_type_arn

The Amazon Resource Number (ARN) of the public extension.

Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

Link

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

Return type

Optional[str]

publisher_id

The ID of the extension publisher.

Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

Link

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

Return type

Optional[str]

type

The extension type.

Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

Link

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

Return type

Optional[str]

type_name

The name of the extension.

Conditional: You must specify PublicTypeArn , or TypeName , Type , and PublisherId .

Link

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

Return type

Optional[str]

type_name_alias

An alias to assign to the public extension, in this account and region.

If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.

Link

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

Return type

Optional[str]

version_bump

Manually updates a previously-activated type to a new major or minor version, if available.

You can also use this parameter to update the value of AutoUpdate .

  • MAJOR : CloudFormation updates the extension to the newest major version, if one is available.

  • MINOR : CloudFormation updates the extension to the newest minor version, if one is available.

Link

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

Return type

Optional[str]