Class ActivateTypeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ActivateTypeRequest.Builder,
ActivateTypeRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.static ActivateTypeRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name of the IAM execution role to use to activate the extension.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final LoggingConfig
Contains logging configuration information for an extension.final Long
The major version of this extension you want to activate, if multiple major versions are available.final String
The Amazon Resource Name (ARN) of the public extension.final String
The ID of the extension publisher.static Class
<? extends ActivateTypeRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ThirdPartyType
type()
The extension type.final String
The extension type.final String
typeName()
The name of the extension.final String
An alias to assign to the public extension, in this account and Region.final VersionBump
Manually updates a previously-activated type to a new major or minor version, if available.final String
Manually updates a previously-activated type to a new major or minor version, if available.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The extension type.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.If the service returns an enum value that is not available in the current SDK version,
type
will returnThirdPartyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The extension type.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
. - See Also:
-
typeAsString
The extension type.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.If the service returns an enum value that is not available in the current SDK version,
type
will returnThirdPartyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The extension type.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
. - See Also:
-
publicTypeArn
The Amazon Resource Name (ARN) of the public extension.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Returns:
- The Amazon Resource Name (ARN) of the public extension.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.
-
publisherId
The ID of the extension publisher.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Returns:
- The ID of the extension publisher.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.
-
typeName
The name of the extension.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.- Returns:
- The name of the extension.
Conditional: You must specify
PublicTypeArn
, orTypeName
,Type
, andPublisherId
.
-
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:
- 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.
-
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:
- 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
.
-
loggingConfig
Contains logging configuration information for an extension.
- Returns:
- Contains logging configuration information for an extension.
-
executionRoleArn
The name of the IAM execution role to use to activate the extension.
- Returns:
- The name of the IAM execution role to use to activate the extension.
-
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.
If the service returns an enum value that is not available in the current SDK version,
versionBump
will returnVersionBump.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromversionBumpAsString()
.- Returns:
- 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.
-
- See Also:
-
-
versionBumpAsString
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.
If the service returns an enum value that is not available in the current SDK version,
versionBump
will returnVersionBump.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromversionBumpAsString()
.- Returns:
- 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.
-
- 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.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ActivateTypeRequest.Builder,
ActivateTypeRequest> - Specified by:
toBuilder
in classCloudFormationRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-