Class InfrastructureConfiguration

java.lang.Object
software.amazon.awssdk.services.imagebuilder.model.InfrastructureConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InfrastructureConfiguration.Builder,InfrastructureConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class InfrastructureConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InfrastructureConfiguration.Builder,InfrastructureConfiguration>

Details of the infrastructure configuration.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the infrastructure configuration.

      Returns:
      The Amazon Resource Name (ARN) of the infrastructure configuration.

    • name

      public final String name()

      The name of the infrastructure configuration.

      Returns:
      The name of the infrastructure configuration.

    • description

      public final String description()

      The description of the infrastructure configuration.

      Returns:
      The description of the infrastructure configuration.

    • hasInstanceTypes

      public final boolean hasInstanceTypes()
      For responses, this returns true if the service returned a value for the InstanceTypes 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.

    • instanceTypes

      public final List<String> instanceTypes()

      The instance types of the infrastructure configuration.

      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 hasInstanceTypes() method.

      Returns:
      The instance types of the infrastructure configuration.

    • instanceProfileName

      public final String instanceProfileName()

      The instance profile of the infrastructure configuration.

      Returns:
      The instance profile of the infrastructure configuration.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds 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.

    • securityGroupIds

      public final List<String> securityGroupIds()

      The security group IDs of the infrastructure configuration.

      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 hasSecurityGroupIds() method.

      Returns:
      The security group IDs of the infrastructure configuration.

    • subnetId

      public final String subnetId()

      The subnet ID of the infrastructure configuration.

      Returns:
      The subnet ID of the infrastructure configuration.

    • logging

      public final Logging logging()

      The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.

      Returns:
      The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.

    • keyPair

      public final String keyPair()

      The Amazon EC2 key pair of the infrastructure configuration.

      Returns:
      The Amazon EC2 key pair of the infrastructure configuration.

    • terminateInstanceOnFailure

      public final Boolean terminateInstanceOnFailure()

      Indicates whether Image Builder terminates the build and test instances when the image build fails. When false, Image Builder retains the instance so that you can debug it.

      Returns:
      Indicates whether Image Builder terminates the build and test instances when the image build fails. When false, Image Builder retains the instance so that you can debug it.

    • snsTopicArn

      public final String snsTopicArn()

      The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics.

      EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.

      Returns:
      The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics.

      EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.

    • dateCreated

      public final String dateCreated()

      The date on which the infrastructure configuration was created.

      Returns:
      The date on which the infrastructure configuration was created.

    • dateUpdated

      public final String dateUpdated()

      The date on which the infrastructure configuration was last updated.

      Returns:
      The date on which the infrastructure configuration was last updated.

    • hasResourceTags

      public final boolean hasResourceTags()
      For responses, this returns true if the service returned a value for the ResourceTags 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.

    • resourceTags

      public final Map<String,String> resourceTags()

      The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder launches during image creation.

      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 hasResourceTags() method.

      Returns:
      The metadata tags assigned to the Amazon EC2 build and test instances that Image Builder launches during image creation.

    • instanceMetadataOptions

      public final InstanceMetadataOptions instanceMetadataOptions()

      The instance metadata option settings for the infrastructure configuration.

      Returns:
      The instance metadata option settings for the infrastructure configuration.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      The tags of the infrastructure configuration.

      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 hasTags() method.

      Returns:
      The tags of the infrastructure configuration.

    • placement

      public final Placement placement()

      The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.

      Returns:
      The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.

    • toBuilder

      public InfrastructureConfiguration.Builder 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 interface ToCopyableBuilder<InfrastructureConfiguration.Builder,InfrastructureConfiguration>
      Returns:
      a builder for type T

    • builder

      public static InfrastructureConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InfrastructureConfiguration.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.