Package software.amazon.awscdk

Interface CfnTypeActivationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTypeActivationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:02.141Z")
@Stability(Stable)
public interface CfnTypeActivationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTypeActivation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnTypeActivationProps cfnTypeActivationProps = CfnTypeActivationProps.builder()
         .autoUpdate(false)
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .majorVersion("majorVersion")
         .publicTypeArn("publicTypeArn")
         .publisherId("publisherId")
         .type("type")
         .typeName("typeName")
         .typeNameAlias("typeNameAlias")
         .versionBump("versionBump")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTypeActivationProps.Builder	A builder for CfnTypeActivationProps
static final class	CfnTypeActivationProps.Jsii$Proxy	An implementation for CfnTypeActivationProps

Method Summary

Modifier and Type	Method	Description
static CfnTypeActivationProps.Builder	builder()
default Object	getAutoUpdate()	Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.
default String	getExecutionRoleArn()	The name of the IAM execution role to use to activate the extension.
default Object	getLoggingConfig()	Specifies logging configuration information for an extension.
default String	getMajorVersion()	The major version of this extension you want to activate, if multiple major versions are available.
default String	getPublicTypeArn()	The Amazon Resource Number (ARN) of the public extension.
default String	getPublisherId()	The ID of the extension publisher.
default String	getType()	The extension type.
default String	getTypeName()	The name of the extension.
default String	getTypeNameAlias()	An alias to assign to the public extension, in this account and Region.
default String	getVersionBump()	Manually updates a previously-activated type to a new major or minor version, if available.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoUpdate

@Stability(Stable)
@Nullable
default Object getAutoUpdate()

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 .

See Also:

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

getExecutionRoleArn

@Stability(Stable)
@Nullable
default String getExecutionRoleArn()

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

See Also:

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

getLoggingConfig

@Stability(Stable)
@Nullable
default Object getLoggingConfig()

Specifies logging configuration information for an extension.

See Also:

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

getMajorVersion

@Stability(Stable)
@Nullable
default String getMajorVersion()

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.

See Also:

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

getPublicTypeArn

@Stability(Stable)
@Nullable
default String getPublicTypeArn()

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

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

See Also:

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

getPublisherId

@Stability(Stable)
@Nullable
default String getPublisherId()

The ID of the extension publisher.

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

See Also:

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

getType

@Stability(Stable)
@Nullable
default String getType()

The extension type.

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

See Also:

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

getTypeName

@Stability(Stable)
@Nullable
default String getTypeName()

The name of the extension.

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

See Also:

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

getTypeNameAlias

@Stability(Stable)
@Nullable
default String getTypeNameAlias()

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.

See Also:

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

getVersionBump

@Stability(Stable)
@Nullable
default String getVersionBump()

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.

See Also:

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

builder

@Stability(Stable)
static CfnTypeActivationProps.Builder builder()

Returns:

a CfnTypeActivationProps.Builder of CfnTypeActivationProps