Class CfnTypeActivation.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTypeActivation>
- Enclosing class:
CfnTypeActivation
CfnTypeActivation
.-
Method Summary
Modifier and TypeMethodDescriptionautoUpdate
(Boolean autoUpdate) Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.autoUpdate
(IResolvable autoUpdate) Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.build()
static CfnTypeActivation.Builder
executionRoleArn
(String executionRoleArn) The name of the IAM execution role to use to activate the extension.loggingConfig
(CfnTypeActivation.LoggingConfigProperty loggingConfig) Specifies logging configuration information for an extension.loggingConfig
(IResolvable loggingConfig) Specifies logging configuration information for an extension.majorVersion
(String majorVersion) The major version of this extension you want to activate, if multiple major versions are available.publicTypeArn
(String publicTypeArn) The Amazon Resource Number (ARN) of the public extension.publisherId
(String publisherId) The ID of the extension publisher.The extension type.The name of the extension.typeNameAlias
(String typeNameAlias) An alias to assign to the public extension, in this account and Region.versionBump
(String versionBump) Manually updates a previously-activated type to a new major or minor version, if available.
-
Method Details
-
create
@Stability(Stable) public static CfnTypeActivation.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnTypeActivation.Builder
.
-
autoUpdate
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
.- Parameters:
autoUpdate
- Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. This parameter is required.- Returns:
this
- See Also:
-
autoUpdate
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
.- Parameters:
autoUpdate
- Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. This parameter is required.- Returns:
this
- See Also:
-
executionRoleArn
The name of the IAM execution role to use to activate the extension.- Parameters:
executionRoleArn
- The name of the IAM execution role to use to activate the extension. This parameter is required.- Returns:
this
- See Also:
-
loggingConfig
Specifies logging configuration information for an extension.- Parameters:
loggingConfig
- Specifies logging configuration information for an extension. This parameter is required.- Returns:
this
- See Also:
-
loggingConfig
@Stability(Stable) public CfnTypeActivation.Builder loggingConfig(CfnTypeActivation.LoggingConfigProperty loggingConfig) Specifies logging configuration information for an extension.- Parameters:
loggingConfig
- Specifies logging configuration information for an extension. This parameter is required.- Returns:
this
- See Also:
-
majorVersion
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
orVersionBump
, but not both.- Parameters:
majorVersion
- The major version of this extension you want to activate, if multiple major versions are available. This parameter is required.- Returns:
this
- See Also:
-
publicTypeArn
The Amazon Resource Number (ARN) of the public extension.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Parameters:
publicTypeArn
- The Amazon Resource Number (ARN) of the public extension. This parameter is required.- Returns:
this
- See Also:
-
publisherId
The ID of the extension publisher.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Parameters:
publisherId
- The ID of the extension publisher. This parameter is required.- Returns:
this
- See Also:
-
type
The extension type.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Parameters:
type
- The extension type. This parameter is required.- Returns:
this
- See Also:
-
typeName
The name of the extension.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Parameters:
typeName
- The name of the extension. This parameter is required.- Returns:
this
- See Also:
-
typeNameAlias
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.
- Parameters:
typeNameAlias
- An alias to assign to the public extension, in this account and Region. This parameter is required.- Returns:
this
- See Also:
-
versionBump
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.
- Parameters:
versionBump
- Manually updates a previously-activated type to a new major or minor version, if available. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnTypeActivation>
- Returns:
- a newly built instance of
CfnTypeActivation
.
-