Package software.amazon.awscdk.services.cloudformation

Class CfnTypeActivation.Builder

java.lang.Object

software.amazon.awscdk.services.cloudformation.CfnTypeActivation.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTypeActivation>

Enclosing class:

CfnTypeActivation

@Stability(Stable)
public static final class CfnTypeActivation.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTypeActivation>

A fluent builder for CfnTypeActivation.

Method Summary

Modifier and Type	Method	Description
CfnTypeActivation.Builder	autoUpdate(Boolean autoUpdate)	Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.
CfnTypeActivation.Builder	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.
CfnTypeActivation	build()
static CfnTypeActivation.Builder	create(software.constructs.Construct scope, String id)
CfnTypeActivation.Builder	executionRoleArn(String executionRoleArn)	The name of the IAM execution role to use to activate the extension.
CfnTypeActivation.Builder	loggingConfig(IResolvable loggingConfig)	Specifies logging configuration information for an extension.
CfnTypeActivation.Builder	loggingConfig(CfnTypeActivation.LoggingConfigProperty loggingConfig)	Specifies logging configuration information for an extension.
CfnTypeActivation.Builder	majorVersion(String majorVersion)	The major version of this extension you want to activate, if multiple major versions are available.
CfnTypeActivation.Builder	publicTypeArn(String publicTypeArn)	The Amazon Resource Number (ARN) of the public extension.
CfnTypeActivation.Builder	publisherId(String publisherId)	The ID of the extension publisher.
CfnTypeActivation.Builder	type(String type)	The extension type.
CfnTypeActivation.Builder	typeName(String typeName)	The name of the extension.
CfnTypeActivation.Builder	typeNameAlias(String typeNameAlias)	An alias to assign to the public extension, in this account and Region.
CfnTypeActivation.Builder	versionBump(String versionBump)	Manually updates a previously-activated type to a new major or minor version, if available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

@Stability(Stable)
public CfnTypeActivation.Builder autoUpdate(Boolean 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate

autoUpdate

@Stability(Stable)
public CfnTypeActivation.Builder 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.

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-autoupdate

executionRoleArn

@Stability(Stable)
public CfnTypeActivation.Builder executionRoleArn(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-executionrolearn

loggingConfig

@Stability(Stable)
public CfnTypeActivation.Builder loggingConfig(IResolvable 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-loggingconfig

majorVersion

@Stability(Stable)
public CfnTypeActivation.Builder majorVersion(String 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 or VersionBump , 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-majorversion

publicTypeArn

@Stability(Stable)
public CfnTypeActivation.Builder publicTypeArn(String publicTypeArn)

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

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

Parameters:

publicTypeArn - The Amazon Resource Number (ARN) of the public extension. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publictypearn

publisherId

@Stability(Stable)
public CfnTypeActivation.Builder publisherId(String publisherId)

The ID of the extension publisher.

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

Parameters:

publisherId - The ID of the extension publisher. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-publisherid

type

@Stability(Stable)
public CfnTypeActivation.Builder type(String type)

The extension type.

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

Parameters:

type - The extension type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-type

typeName

@Stability(Stable)
public CfnTypeActivation.Builder typeName(String typeName)

The name of the extension.

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

Parameters:

typeName - The name of the extension. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typename

typeNameAlias

@Stability(Stable)
public CfnTypeActivation.Builder typeNameAlias(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-typenamealias

versionBump

@Stability(Stable)
public CfnTypeActivation.Builder versionBump(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-typeactivation.html#cfn-cloudformation-typeactivation-versionbump

build

@Stability(Stable)
public CfnTypeActivation build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTypeActivation>

Returns:

a newly built instance of CfnTypeActivation.