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.57.0 (build f614666)",
           date="2022-04-22T09:30:44.500Z")
 @Stability(value=Stable)
public class CfnTypeActivation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFormation::TypeActivation`.

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.*;
 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();
 

Nested Class Summary

Nested Classes

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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTypeActivation(software.constructs.Construct scope, String id) Create a new `AWS::CloudFormation::TypeActivation`.
	CfnTypeActivation(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Number (ARN) of the activated extension, in this account and Region.
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 Map<String,Object>	getCfnProperties()
String	getExecutionRoleArn() The name of the IAM execution role to use to activate the extension.
Object	getLoggingConfig() Specifies logging configuration information for an extension.
String	getMajorVersion() The major version of this extension you want to activate, if multiple major versions are available.
String	getPublicTypeArn() The Amazon Resource Number (ARN) of the public extension.
String	getPublisherId() The ID of the extension publisher.
String	getType() The extension type.
String	getTypeName() The name of the extension.
String	getTypeNameAlias() An alias to assign to the public extension, in this account and region.
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 Map<String,Object>	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	setLoggingConfig(CfnTypeActivation.LoggingConfigProperty value) 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	setType(String value) 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, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTypeActivation

protected CfnTypeActivation(software.amazon.jsii.JsiiObjectRef objRef)

CfnTypeActivation

protected CfnTypeActivation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTypeActivation

@Stability(value=Stable)
public CfnTypeActivation(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @Nullable
                                                  CfnTypeActivationProps props)

Create a new `AWS::CloudFormation::TypeActivation`.

Parameters:

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.

CfnTypeActivation

@Stability(value=Stable)
public CfnTypeActivation(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id)

Create a new `AWS::CloudFormation::TypeActivation`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Number (ARN) of the activated extension, in this account and Region.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAutoUpdate

@Stability(value=Stable)
 @Nullable
public 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 .

setAutoUpdate

@Stability(value=Stable)
public void setAutoUpdate(@Nullable
                                                   Boolean value)

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 .

setAutoUpdate

@Stability(value=Stable)
public void setAutoUpdate(@Nullable
                                                   IResolvable value)

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

@Stability(value=Stable)
 @Nullable
public String getExecutionRoleArn()

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

setExecutionRoleArn

@Stability(value=Stable)
public void setExecutionRoleArn(@Nullable
                                                         String value)

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

getLoggingConfig

@Stability(value=Stable)
 @Nullable
public Object getLoggingConfig()

Specifies logging configuration information for an extension.

setLoggingConfig

@Stability(value=Stable)
public void setLoggingConfig(@Nullable
                                                      IResolvable value)

Specifies logging configuration information for an extension.

setLoggingConfig

@Stability(value=Stable)
public void setLoggingConfig(@Nullable
                                                      CfnTypeActivation.LoggingConfigProperty value)

Specifies logging configuration information for an extension.

getMajorVersion

@Stability(value=Stable)
 @Nullable
public 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.

setMajorVersion

@Stability(value=Stable)
public void setMajorVersion(@Nullable
                                                     String value)

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.

getPublicTypeArn

@Stability(value=Stable)
 @Nullable
public String getPublicTypeArn()

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

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

setPublicTypeArn

@Stability(value=Stable)
public void setPublicTypeArn(@Nullable
                                                      String value)

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

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

getPublisherId

@Stability(value=Stable)
 @Nullable
public String getPublisherId()

The ID of the extension publisher.

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

setPublisherId

@Stability(value=Stable)
public void setPublisherId(@Nullable
                                                    String value)

The ID of the extension publisher.

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

getType

@Stability(value=Stable)
 @Nullable
public String getType()

The extension type.

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

setType

@Stability(value=Stable)
public void setType(@Nullable
                                             String value)

The extension type.

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

getTypeName

@Stability(value=Stable)
 @Nullable
public String getTypeName()

The name of the extension.

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

setTypeName

@Stability(value=Stable)
public void setTypeName(@Nullable
                                                 String value)

The name of the extension.

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

getTypeNameAlias

@Stability(value=Stable)
 @Nullable
public 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.

setTypeNameAlias

@Stability(value=Stable)
public void setTypeNameAlias(@Nullable
                                                      String value)

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

@Stability(value=Stable)
 @Nullable
public 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.

setVersionBump

@Stability(value=Stable)
public void setVersionBump(@Nullable
                                                    String value)

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.