Package software.amazon.awssdk.services.cloudformation.model

Interface ActivateTypeRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<ActivateTypeRequest.Builder,ActivateTypeRequest>, SdkBuilder<ActivateTypeRequest.Builder,ActivateTypeRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ActivateTypeRequest

@Mutable
@NotThreadSafe
public static interface ActivateTypeRequest.Builder
extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<ActivateTypeRequest.Builder,ActivateTypeRequest>

Method Summary

Modifier and Type	Method	Description
ActivateTypeRequest.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.
ActivateTypeRequest.Builder	executionRoleArn(String executionRoleArn)	The name of the IAM execution role to use to activate the extension.
default ActivateTypeRequest.Builder	loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)	Contains logging configuration information for an extension.
ActivateTypeRequest.Builder	loggingConfig(LoggingConfig loggingConfig)	Contains logging configuration information for an extension.
ActivateTypeRequest.Builder	majorVersion(Long majorVersion)	The major version of this extension you want to activate, if multiple major versions are available.
ActivateTypeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ActivateTypeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ActivateTypeRequest.Builder	publicTypeArn(String publicTypeArn)	The Amazon Resource Name (ARN) of the public extension.
ActivateTypeRequest.Builder	publisherId(String publisherId)	The ID of the extension publisher.
ActivateTypeRequest.Builder	type(String type)	The extension type.
ActivateTypeRequest.Builder	type(ThirdPartyType type)	The extension type.
ActivateTypeRequest.Builder	typeName(String typeName)	The name of the extension.
ActivateTypeRequest.Builder	typeNameAlias(String typeNameAlias)	An alias to assign to the public extension in this account and Region.
ActivateTypeRequest.Builder	versionBump(String versionBump)	Manually updates a previously-activated type to a new major or minor version, if available.
ActivateTypeRequest.Builder	versionBump(VersionBump versionBump)	Manually updates a previously-activated type to a new major or minor version, if available.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

type

ActivateTypeRequest.Builder type(String type)

The extension type.

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

Parameters:

type - The extension type.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ThirdPartyType, ThirdPartyType

type

ActivateTypeRequest.Builder type(ThirdPartyType type)

The extension type.

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

Parameters:

type - The extension type.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ThirdPartyType, ThirdPartyType

publicTypeArn

ActivateTypeRequest.Builder publicTypeArn(String publicTypeArn)

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

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

Parameters:

publicTypeArn - The Amazon Resource Name (ARN) of the public extension.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

publisherId

ActivateTypeRequest.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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

typeName

ActivateTypeRequest.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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

typeNameAlias

ActivateTypeRequest.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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

autoUpdate

ActivateTypeRequest.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. Major versions released by the publisher must be manually updated.

The default is true.

Returns:

Returns a reference to this object so that method calls can be chained together.

loggingConfig

ActivateTypeRequest.Builder loggingConfig(LoggingConfig loggingConfig)

Contains logging configuration information for an extension.

Parameters:

loggingConfig - Contains logging configuration information for an extension.

Returns:

Returns a reference to this object so that method calls can be chained together.

loggingConfig

default ActivateTypeRequest.Builder loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)

Contains logging configuration information for an extension.

This is a convenience method that creates an instance of the LoggingConfig.Builder avoiding the need to create one manually via LoggingConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfig(LoggingConfig).

Parameters:

loggingConfig - a consumer that will call methods on LoggingConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

loggingConfig(LoggingConfig)

executionRoleArn

ActivateTypeRequest.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.

Returns:

Returns a reference to this object so that method calls can be chained together.

versionBump

ActivateTypeRequest.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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VersionBump, VersionBump

versionBump

ActivateTypeRequest.Builder versionBump(VersionBump 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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VersionBump, VersionBump

majorVersion

ActivateTypeRequest.Builder majorVersion(Long 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. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ActivateTypeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ActivateTypeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder