java.lang.Object
- software.amazon.awssdk.services.imagebuilder.model.AmiDistributionConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AmiDistributionConfiguration.Builder,AmiDistributionConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class AmiDistributionConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AmiDistributionConfiguration.Builder,AmiDistributionConfiguration>

Define and configure the output AMIs of the pipeline.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AmiDistributionConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`amiTags()`	The tags to apply to AMIs distributed to this Region.
`static AmiDistributionConfiguration.Builder`	`builder()`
`String`	`description()`	The description of the AMI distribution configuration.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAmiTags()`	For responses, this returns true if the service returned a value for the AmiTags property.
`int`	`hashCode()`
`boolean`	`hasTargetAccountIds()`	For responses, this returns true if the service returned a value for the TargetAccountIds property.
`String`	`kmsKeyId()`	The KMS key identifier used to encrypt the distributed image.
`LaunchPermissionConfiguration`	`launchPermission()`	Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
`String`	`name()`	The name of the output AMI.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AmiDistributionConfiguration.Builder>`	`serializableBuilderClass()`
`List<String>`	`targetAccountIds()`	The ID of an account to which you want to distribute an image.
`AmiDistributionConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - name
```
public final String name()
```
    The name of the output AMI.
    
    Returns:
    
    The name of the output AMI.
  - description
```
public final String description()
```
    The description of the AMI distribution configuration. Minimum and maximum length are in characters.
    
    Returns:
    
    The description of the AMI distribution configuration. Minimum and maximum length are in characters.
  - hasTargetAccountIds
```
public final boolean hasTargetAccountIds()
```
    For responses, this returns true if the service returned a value for the TargetAccountIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - targetAccountIds
```
public final List<String> targetAccountIds()
```
    The ID of an account to which you want to distribute an image.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetAccountIds() method.
    
    Returns:
    
    The ID of an account to which you want to distribute an image.
  - hasAmiTags
```
public final boolean hasAmiTags()
```
    For responses, this returns true if the service returned a value for the AmiTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - amiTags
```
public final Map<String,String> amiTags()
```
    The tags to apply to AMIs distributed to this Region.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAmiTags() method.
    
    Returns:
    
    The tags to apply to AMIs distributed to this Region.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The KMS key identifier used to encrypt the distributed image.
    
    Returns:
    
    The KMS key identifier used to encrypt the distributed image.
  - launchPermission
```
public final LaunchPermissionConfiguration launchPermission()
```
    Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
    
    Returns:
    
    Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
  - toBuilder
```
public AmiDistributionConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AmiDistributionConfiguration.Builder,AmiDistributionConfiguration>
  - builder
```
public static AmiDistributionConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AmiDistributionConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AmiDistributionConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

description

hasTargetAccountIds

targetAccountIds

hasAmiTags

amiTags

kmsKeyId

launchPermission

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields