Package software.amazon.awscdk
Class CfnTypeActivation
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.CfnTypeActivation
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-11T23:26:27.487Z")
@Stability(Stable)
public class CfnTypeActivation
extends CfnResource
implements IInspectable
Activates a public third-party extension, making it available for use in stack templates.
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 Using public extensions in the AWS 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.*; 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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnTypeActivation
.static interface
Contains logging configuration information for an extension.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnTypeActivation
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnTypeActivation
(software.amazon.jsii.JsiiObjectRef objRef) CfnTypeActivation
(software.constructs.Construct scope, String id) CfnTypeActivation
(software.constructs.Construct scope, String id, CfnTypeActivationProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the activated extension, in this account and Region.Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.The name of the IAM execution role to use to activate the extension.Specifies logging configuration information for an extension.The major version of this extension you want to activate, if multiple major versions are available.The Amazon Resource Number (ARN) of the public extension.The ID of the extension publisher.getType()
The extension type.The name of the extension.An alias to assign to the public extension, in this account and Region.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.renderProperties
(Map<String, Object> props) void
setAutoUpdate
(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
(String value) The name of the IAM execution role to use to activate the extension.void
Specifies logging configuration information for an extension.void
setLoggingConfig
(IResolvable value) Specifies logging configuration information for an extension.void
setMajorVersion
(String value) The major version of this extension you want to activate, if multiple major versions are available.void
setPublicTypeArn
(String value) The Amazon Resource Number (ARN) of the public extension.void
setPublisherId
(String value) The ID of the extension publisher.void
The extension type.void
setTypeName
(String value) The name of the extension.void
setTypeNameAlias
(String value) An alias to assign to the public extension, in this account and Region.void
setVersionBump
(String value) Manually updates a previously-activated type to a new major or minor version, if available.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnTypeActivation
protected CfnTypeActivation(software.amazon.jsii.JsiiObjectRef objRef) -
CfnTypeActivation
protected CfnTypeActivation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnTypeActivation
@Stability(Stable) public CfnTypeActivation(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnTypeActivationProps props) - 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.props
- Resource properties.
-
CfnTypeActivation
@Stability(Stable) public CfnTypeActivation(@NotNull software.constructs.Construct scope, @NotNull 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.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the activated extension, in this account and Region. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAutoUpdate
Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. -
setAutoUpdate
Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. -
setAutoUpdate
Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher. -
getExecutionRoleArn
The name of the IAM execution role to use to activate the extension. -
setExecutionRoleArn
The name of the IAM execution role to use to activate the extension. -
getLoggingConfig
Specifies logging configuration information for an extension. -
setLoggingConfig
Specifies logging configuration information for an extension. -
setLoggingConfig
@Stability(Stable) public void setLoggingConfig(@Nullable CfnTypeActivation.LoggingConfigProperty value) Specifies logging configuration information for an extension. -
getMajorVersion
The major version of this extension you want to activate, if multiple major versions are available. -
setMajorVersion
The major version of this extension you want to activate, if multiple major versions are available. -
getPublicTypeArn
The Amazon Resource Number (ARN) of the public extension. -
setPublicTypeArn
The Amazon Resource Number (ARN) of the public extension. -
getPublisherId
The ID of the extension publisher. -
setPublisherId
The ID of the extension publisher. -
getType
The extension type. -
setType
The extension type. -
getTypeName
The name of the extension. -
setTypeName
The name of the extension. -
getTypeNameAlias
An alias to assign to the public extension, in this account and Region. -
setTypeNameAlias
An alias to assign to the public extension, in this account and Region. -
getVersionBump
Manually updates a previously-activated type to a new major or minor version, if available. -
setVersionBump
Manually updates a previously-activated type to a new major or minor version, if available.
-