ActivateTypeRequest (AWS Java SDK :: Services :: AWS CloudFormation 2.17.114 API)

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(value="software.amazon.awssdk:codegen")
public final class ActivateTypeRequest
extends CloudFormationRequest
implements ToCopyableBuilder<ActivateTypeRequest.Builder,ActivateTypeRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ActivateTypeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ActivateTypeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`autoUpdate()` 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()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRoleArn()` The name of the IAM execution role to use to activate the extension.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LoggingConfig`	`loggingConfig()` Returns the value of the LoggingConfig property for this object.
`Long`	`majorVersion()` The major version of this extension you want to activate, if multiple major versions are available.
`String`	`publicTypeArn()` The Amazon Resource Number (ARN) of the public extension.
`String`	`publisherId()` The ID of the extension publisher.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ActivateTypeRequest.Builder>`	`serializableBuilderClass()`
`ActivateTypeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ThirdPartyType`	`type()` The extension type.
`String`	`typeAsString()` The extension type.
`String`	`typeName()` The name of the extension.
`String`	`typeNameAlias()` An alias to assign to the public extension, in this account and region.
`VersionBump`	`versionBump()` Manually updates a previously-activated type to a new major or minor version, if available.
`String`	`versionBumpAsString()` 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, or TypeName, Type, and PublisherId.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ThirdPartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The extension type.
    
    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
    
    See Also:
    
    ThirdPartyType
  - typeAsString
```
public final String typeAsString()
```
    The extension type.
    
    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ThirdPartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The extension type.
    
    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
    
    See Also:
    
    ThirdPartyType
  - publicTypeArn
```
public final String publicTypeArn()
```
    The Amazon Resource Number (ARN) of the public extension.
    
    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the public extension.
    
    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
  - publisherId
```
public final String publisherId()
```
    The ID of the extension publisher.
    
    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
    
    Returns:
    
    The ID of the extension publisher.
    
    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
  - typeName
```
public final String typeName()
```
    The name of the extension.
    
    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
    
    Returns:
    
    The name of the extension.
    
    Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.
  - 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()
```
    Returns the value of the LoggingConfig property for this object.
    
    Returns:
    
    The value of the LoggingConfig property for this object.
  - 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, versionBump will return VersionBump.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionBumpAsString().
    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, versionBump will return VersionBump.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from versionBumpAsString().
    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 MajorVersion or VersionBump, 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 or VersionBump, but not both.
  - toBuilder
```
public ActivateTypeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ActivateTypeRequest.Builder,ActivateTypeRequest>
    
    Specified by:
    
    toBuilder in class CloudFormationRequest
  - builder
```
public static ActivateTypeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ActivateTypeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ActivateTypeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

type

typeAsString

publicTypeArn

publisherId

typeName

typeNameAlias

autoUpdate

loggingConfig

executionRoleArn

versionBump

versionBumpAsString

majorVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields