Interface ActivateTypeRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudFormationRequest.Builder
,CopyableBuilder<ActivateTypeRequest.Builder,
,ActivateTypeRequest> SdkBuilder<ActivateTypeRequest.Builder,
,ActivateTypeRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ActivateTypeRequest
-
Method Summary
Modifier and TypeMethodDescriptionautoUpdate
(Boolean autoUpdate) Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.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.loggingConfig
(LoggingConfig loggingConfig) Contains logging configuration information for an extension.majorVersion
(Long majorVersion) The major version of this extension you want to activate, if multiple major versions are available.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.publicTypeArn
(String publicTypeArn) The Amazon Resource Name (ARN) of the public extension.publisherId
(String publisherId) The ID of the extension publisher.The extension type.type
(ThirdPartyType type) The extension type.The name of the extension.typeNameAlias
(String typeNameAlias) An alias to assign to the public extension, in this account and Region.versionBump
(String versionBump) Manually updates a previously-activated type to a new major or minor version, if available.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, sdkFields
-
Method Details
-
type
The extension type.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Parameters:
type
- The extension type.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The extension type.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Parameters:
type
- The extension type.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
publicTypeArn
The Amazon Resource Name (ARN) of the public extension.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Parameters:
publicTypeArn
- The Amazon Resource Name (ARN) of the public extension.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publisherId
The ID of the extension publisher.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Parameters:
publisherId
- The ID of the extension publisher.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
typeName
The name of the extension.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Parameters:
typeName
- The name of the extension.Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
Contains logging configuration information for an extension.
This is a convenience method that creates an instance of theLoggingConfig.Builder
avoiding the need to create one manually viaLoggingConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologgingConfig(LoggingConfig)
.- Parameters:
loggingConfig
- a consumer that will call methods onLoggingConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 ofAutoUpdate
.-
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
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 ofAutoUpdate
.-
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:
-
-
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
orVersionBump
, 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
orVersionBump
, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ActivateTypeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ActivateTypeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-