@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:44.839Z") public class CfnTypeActivation extends CfnResource implements IInspectable
Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the AWS CloudFormation User Guide .
Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cloudformation.*; CfnTypeActivation cfnTypeActivation = CfnTypeActivation.Builder.create(this, "MyCfnTypeActivation") .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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnTypeActivation.Builder
A fluent builder for
CfnTypeActivation . |
static interface |
CfnTypeActivation.LoggingConfigProperty
Contains logging configuration information for an extension.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnTypeActivation(Construct scope,
java.lang.String id)
Create a new `AWS::CloudFormation::TypeActivation`.
|
|
CfnTypeActivation(Construct scope,
java.lang.String id,
CfnTypeActivationProps props)
Create a new `AWS::CloudFormation::TypeActivation`.
|
protected |
CfnTypeActivation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnTypeActivation(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Number (ARN) of the activated extension, in this account and Region.
|
java.lang.Object |
getAutoUpdate()
Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getExecutionRoleArn()
The name of the IAM execution role to use to activate the extension.
|
java.lang.Object |
getLoggingConfig()
Specifies logging configuration information for an extension.
|
java.lang.String |
getMajorVersion()
The major version of this extension you want to activate, if multiple major versions are available.
|
java.lang.String |
getPublicTypeArn()
The Amazon Resource Number (ARN) of the public extension.
|
java.lang.String |
getPublisherId()
The ID of the extension publisher.
|
java.lang.String |
getType()
The extension type.
|
java.lang.String |
getTypeName()
The name of the extension.
|
java.lang.String |
getTypeNameAlias()
An alias to assign to the public extension, in this account and Region.
|
java.lang.String |
getVersionBump()
Manually updates a previously-activated type to a new major or minor version, if available.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAutoUpdate(java.lang.Boolean value)
Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher.
|
void |
setAutoUpdate(IResolvable value)
Whether to automatically update the extension in this account and Region when a new *minor* version is published by the extension publisher.
|
void |
setExecutionRoleArn(java.lang.String value)
The name of the IAM execution role to use to activate the extension.
|
void |
setLoggingConfig(CfnTypeActivation.LoggingConfigProperty value)
Specifies logging configuration information for an extension.
|
void |
setLoggingConfig(IResolvable value)
Specifies logging configuration information for an extension.
|
void |
setMajorVersion(java.lang.String value)
The major version of this extension you want to activate, if multiple major versions are available.
|
void |
setPublicTypeArn(java.lang.String value)
The Amazon Resource Number (ARN) of the public extension.
|
void |
setPublisherId(java.lang.String value)
The ID of the extension publisher.
|
void |
setType(java.lang.String value)
The extension type.
|
void |
setTypeName(java.lang.String value)
The name of the extension.
|
void |
setTypeNameAlias(java.lang.String value)
An alias to assign to the public extension, in this account and Region.
|
void |
setVersionBump(java.lang.String value)
Manually updates a previously-activated type to a new major or minor version, if available.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnTypeActivation(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnTypeActivation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnTypeActivation(Construct scope, java.lang.String id, CfnTypeActivationProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties.public CfnTypeActivation(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getAutoUpdate()
Major versions released by the publisher must be manually updated.
The default is true
.
public void setAutoUpdate(java.lang.Boolean value)
Major versions released by the publisher must be manually updated.
The default is true
.
public void setAutoUpdate(IResolvable value)
Major versions released by the publisher must be manually updated.
The default is true
.
public java.lang.String getExecutionRoleArn()
public void setExecutionRoleArn(java.lang.String value)
public java.lang.Object getLoggingConfig()
public void setLoggingConfig(IResolvable value)
public void setLoggingConfig(CfnTypeActivation.LoggingConfigProperty value)
public java.lang.String getMajorVersion()
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 void setMajorVersion(java.lang.String value)
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 java.lang.String getPublicTypeArn()
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
public void setPublicTypeArn(java.lang.String value)
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
public java.lang.String getPublisherId()
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
public void setPublisherId(java.lang.String value)
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
public java.lang.String getType()
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
public void setType(java.lang.String value)
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
public java.lang.String getTypeName()
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
public void setTypeName(java.lang.String value)
Conditional: You must specify PublicTypeArn
, or TypeName
, Type
, and PublisherId
.
public java.lang.String getTypeNameAlias()
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.
public void setTypeNameAlias(java.lang.String value)
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.
public java.lang.String getVersionBump()
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.public void setVersionBump(java.lang.String value)
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.