Class AmiDistributionConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AmiDistributionConfiguration.Builder,
AmiDistributionConfiguration>
Define and configure the output AMIs of the pipeline.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionamiTags()
The tags to apply to AMIs distributed to this Region.builder()
final String
The description of the AMI distribution configuration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AmiTags property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TargetAccountIds property.final String
kmsKeyId()
The KMS key identifier used to encrypt the distributed image.Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.final String
name()
The name of the output AMI.static Class
<? extends AmiDistributionConfiguration.Builder> The ID of an account to which you want to distribute an image.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the output AMI.
- Returns:
- The name of the output AMI.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
The KMS key identifier used to encrypt the distributed image.
- Returns:
- The KMS key identifier used to encrypt the distributed image.
-
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
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<AmiDistributionConfiguration.Builder,
AmiDistributionConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-