AmiDistributionConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.imagebuilder.model.AmiDistributionConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmiDistributionConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Define and configure the output AMIs of the pipeline.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AmiDistributionConfiguration()

Constructors
Constructor and Description
`AmiDistributionConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AmiDistributionConfiguration`	`addAmiTagsEntry(String key, String value)` Add a single AmiTags entry
`AmiDistributionConfiguration`	`clearAmiTagsEntries()` Removes all the entries added into AmiTags.
`AmiDistributionConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAmiTags()` The tags to apply to AMIs distributed to this Region.
`String`	`getDescription()` The description of the AMI distribution configuration.
`String`	`getKmsKeyId()` The KMS key identifier used to encrypt the distributed image.
`LaunchPermissionConfiguration`	`getLaunchPermission()` Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
`String`	`getName()` The name of the output AMI.
`List<String>`	`getTargetAccountIds()` The ID of an account to which you want to distribute an image.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAmiTags(Map<String,String> amiTags)` The tags to apply to AMIs distributed to this Region.
`void`	`setDescription(String description)` The description of the AMI distribution configuration.
`void`	`setKmsKeyId(String kmsKeyId)` The KMS key identifier used to encrypt the distributed image.
`void`	`setLaunchPermission(LaunchPermissionConfiguration launchPermission)` Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
`void`	`setName(String name)` The name of the output AMI.
`void`	`setTargetAccountIds(Collection<String> targetAccountIds)` The ID of an account to which you want to distribute an image.
`String`	`toString()` Returns a string representation of this object.
`AmiDistributionConfiguration`	`withAmiTags(Map<String,String> amiTags)` The tags to apply to AMIs distributed to this Region.
`AmiDistributionConfiguration`	`withDescription(String description)` The description of the AMI distribution configuration.
`AmiDistributionConfiguration`	`withKmsKeyId(String kmsKeyId)` The KMS key identifier used to encrypt the distributed image.
`AmiDistributionConfiguration`	`withLaunchPermission(LaunchPermissionConfiguration launchPermission)` Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
`AmiDistributionConfiguration`	`withName(String name)` The name of the output AMI.
`AmiDistributionConfiguration`	`withTargetAccountIds(Collection<String> targetAccountIds)` The ID of an account to which you want to distribute an image.
`AmiDistributionConfiguration`	`withTargetAccountIds(String... targetAccountIds)` The ID of an account to which you want to distribute an image.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AmiDistributionConfiguration
```
public AmiDistributionConfiguration()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the output AMI.
    
    Parameters:
    
    name - The name of the output AMI.
  - getName
```
public String getName()
```
    The name of the output AMI.
    
    Returns:
    
    The name of the output AMI.
  - withName
```
public AmiDistributionConfiguration withName(String name)
```
    The name of the output AMI.
    
    Parameters:
    
    name - The name of the output AMI.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the AMI distribution configuration. Minimum and maximum length are in characters.
    
    Parameters:
    
    description - The description of the AMI distribution configuration. Minimum and maximum length are in characters.
  - getDescription
```
public String getDescription()
```
    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.
  - withDescription
```
public AmiDistributionConfiguration withDescription(String description)
```
    The description of the AMI distribution configuration. Minimum and maximum length are in characters.
    
    Parameters:
    
    description - The description of the AMI distribution configuration. Minimum and maximum length are in characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTargetAccountIds
```
public List<String> getTargetAccountIds()
```
    The ID of an account to which you want to distribute an image.
    
    Returns:
    
    The ID of an account to which you want to distribute an image.
  - setTargetAccountIds
```
public void setTargetAccountIds(Collection<String> targetAccountIds)
```
    The ID of an account to which you want to distribute an image.
    
    Parameters:
    
    targetAccountIds - The ID of an account to which you want to distribute an image.
  - withTargetAccountIds
```
public AmiDistributionConfiguration withTargetAccountIds(String... targetAccountIds)
```
    The ID of an account to which you want to distribute an image.
    
    NOTE: This method appends the values to the existing list (if any). Use setTargetAccountIds(java.util.Collection) or withTargetAccountIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    targetAccountIds - The ID of an account to which you want to distribute an image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTargetAccountIds
```
public AmiDistributionConfiguration withTargetAccountIds(Collection<String> targetAccountIds)
```
    The ID of an account to which you want to distribute an image.
    
    Parameters:
    
    targetAccountIds - The ID of an account to which you want to distribute an image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAmiTags
```
public Map<String,String> getAmiTags()
```
    The tags to apply to AMIs distributed to this Region.
    
    Returns:
    
    The tags to apply to AMIs distributed to this Region.
  - setAmiTags
```
public void setAmiTags(Map<String,String> amiTags)
```
    The tags to apply to AMIs distributed to this Region.
    
    Parameters:
    
    amiTags - The tags to apply to AMIs distributed to this Region.
  - withAmiTags
```
public AmiDistributionConfiguration withAmiTags(Map<String,String> amiTags)
```
    The tags to apply to AMIs distributed to this Region.
    
    Parameters:
    
    amiTags - The tags to apply to AMIs distributed to this Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAmiTagsEntry
```
public AmiDistributionConfiguration addAmiTagsEntry(String key,
                                                    String value)
```
    Add a single AmiTags entry
    
    See Also:
    
    withAmiTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearAmiTagsEntries
```
public AmiDistributionConfiguration clearAmiTagsEntries()
```
    Removes all the entries added into AmiTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The KMS key identifier used to encrypt the distributed image.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier used to encrypt the distributed image.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The KMS key identifier used to encrypt the distributed image.
    
    Returns:
    
    The KMS key identifier used to encrypt the distributed image.
  - withKmsKeyId
```
public AmiDistributionConfiguration withKmsKeyId(String kmsKeyId)
```
    The KMS key identifier used to encrypt the distributed image.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier used to encrypt the distributed image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLaunchPermission
```
public void setLaunchPermission(LaunchPermissionConfiguration launchPermission)
```
    Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
    
    Parameters:
    
    launchPermission - Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
  - getLaunchPermission
```
public LaunchPermissionConfiguration getLaunchPermission()
```
    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.
  - withLaunchPermission
```
public AmiDistributionConfiguration withLaunchPermission(LaunchPermissionConfiguration launchPermission)
```
    Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
    
    Parameters:
    
    launchPermission - Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AmiDistributionConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class AmiDistributionConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AmiDistributionConfiguration

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

getTargetAccountIds

setTargetAccountIds

withTargetAccountIds

withTargetAccountIds

getAmiTags

setAmiTags

withAmiTags

addAmiTagsEntry

clearAmiTagsEntries

setKmsKeyId

getKmsKeyId

withKmsKeyId

setLaunchPermission

getLaunchPermission

withLaunchPermission

toString

equals

hashCode

clone

marshall