Interface CfnTypeActivationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTypeActivationProps.Jsii$Proxy
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.core.*; 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();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTypeActivationProps
static final class
An implementation forCfnTypeActivationProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.default String
The name of the IAM execution role to use to activate the extension.default Object
Specifies logging configuration information for an extension.default String
The major version of this extension you want to activate, if multiple major versions are available.default String
The Amazon Resource Number (ARN) of the public extension.default String
The ID of the extension publisher.default String
getType()
The extension type.default String
The name of the extension.default String
An alias to assign to the public extension, in this account and Region.default String
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
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
. -
getExecutionRoleArn
The name of the IAM execution role to use to activate the extension. -
getLoggingConfig
Specifies logging configuration information for an extension. -
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
orVersionBump
, but not both. -
getPublicTypeArn
The Amazon Resource Number (ARN) of the public extension.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
. -
getPublisherId
The ID of the extension publisher.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
. -
getType
The extension type.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
. -
getTypeName
The name of the extension.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
. -
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.
-
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.
-
builder
- Returns:
- a
CfnTypeActivationProps.Builder
ofCfnTypeActivationProps
-