Class ActivateTypeRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
-
- software.amazon.awssdk.services.cloudformation.model.ActivateTypeRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ActivateTypeRequest.Builder,ActivateTypeRequest>
@Generated("software.amazon.awssdk:codegen") public final class ActivateTypeRequest extends CloudFormationRequest implements ToCopyableBuilder<ActivateTypeRequest.Builder,ActivateTypeRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceActivateTypeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanautoUpdate()Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.static ActivateTypeRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexecutionRoleArn()The name of the IAM execution role to use to activate the extension.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()LoggingConfigloggingConfig()Contains logging configuration information for an extension.LongmajorVersion()The major version of this extension you want to activate, if multiple major versions are available.StringpublicTypeArn()The Amazon Resource Name (ARN) of the public extension.StringpublisherId()The ID of the extension publisher.List<SdkField<?>>sdkFields()static Class<? extends ActivateTypeRequest.Builder>serializableBuilderClass()ActivateTypeRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.ThirdPartyTypetype()The extension type.StringtypeAsString()The extension type.StringtypeName()The name of the extension.StringtypeNameAlias()An alias to assign to the public extension, in this account and Region.VersionBumpversionBump()Manually updates a previously-activated type to a new major or minor version, if available.StringversionBumpAsString()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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
type
public final ThirdPartyType 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,
typewill 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:
ThirdPartyType
-
typeAsString
public final String 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,
typewill 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:
ThirdPartyType
-
publicTypeArn
public final String 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
public final String 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
public final String 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
public final 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.
- 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
public final 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.- 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
public final LoggingConfig loggingConfig()
Contains logging configuration information for an extension.
- Returns:
- Contains logging configuration information for an extension.
-
executionRoleArn
public final String 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
public final 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.
If the service returns an enum value that is not available in the current SDK version,
versionBumpwill 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:
VersionBump
-
-
versionBumpAsString
public final String 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,
versionBumpwill 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:
VersionBump
-
-
majorVersion
public final 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
MajorVersionorVersionBump, 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
MajorVersionorVersionBump, but not both.
-
toBuilder
public ActivateTypeRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ActivateTypeRequest.Builder,ActivateTypeRequest>- Specified by:
toBuilderin classCloudFormationRequest
-
builder
public static ActivateTypeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ActivateTypeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-