Class CreateInfrastructureConfigurationRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest
-
- software.amazon.awssdk.services.imagebuilder.model.CreateInfrastructureConfigurationRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateInfrastructureConfigurationRequest.Builder,CreateInfrastructureConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateInfrastructureConfigurationRequest extends ImagebuilderRequest implements ToCopyableBuilder<CreateInfrastructureConfigurationRequest.Builder,CreateInfrastructureConfigurationRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateInfrastructureConfigurationRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateInfrastructureConfigurationRequest.Builderbuilder()StringclientToken()Unique, case-sensitive identifier you provide to ensure idempotency of the request.Stringdescription()The description of the infrastructure configuration.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasInstanceTypes()For responses, this returns true if the service returned a value for the InstanceTypes property.booleanhasResourceTags()For responses, this returns true if the service returned a value for the ResourceTags property.booleanhasSecurityGroupIds()For responses, this returns true if the service returned a value for the SecurityGroupIds property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.InstanceMetadataOptionsinstanceMetadataOptions()The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.StringinstanceProfileName()The instance profile to associate with the instance used to customize your Amazon EC2 AMI.List<String>instanceTypes()The instance types of the infrastructure configuration.StringkeyPair()The key pair of the infrastructure configuration.Logginglogging()The logging configuration of the infrastructure configuration.Stringname()The name of the infrastructure configuration.Map<String,String>resourceTags()The tags attached to the resource created by Image Builder.List<SdkField<?>>sdkFields()List<String>securityGroupIds()The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.static Class<? extends CreateInfrastructureConfigurationRequest.Builder>serializableBuilderClass()StringsnsTopicArn()The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.StringsubnetId()The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.Map<String,String>tags()The tags of the infrastructure configuration.BooleanterminateInstanceOnFailure()The terminate instance on failure setting of the infrastructure configuration.CreateInfrastructureConfigurationRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
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 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.
-
instanceTypes
public final List<String> instanceTypes()
The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
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. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.
-
instanceProfileName
public final String instanceProfileName()
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
- Returns:
- The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
-
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 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.
-
securityGroupIds
public final List<String> securityGroupIds()
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
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 to associate with the instance used to customize your Amazon EC2 AMI.
-
subnetId
public final String subnetId()
The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
- Returns:
- The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
-
logging
public final Logging logging()
The logging configuration of the infrastructure configuration.
- Returns:
- The logging configuration of the infrastructure configuration.
-
keyPair
public final String keyPair()
The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
- Returns:
- The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
-
terminateInstanceOnFailure
public final Boolean terminateInstanceOnFailure()
The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
- Returns:
- The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.
-
snsTopicArn
public final String snsTopicArn()
The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
- Returns:
- The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
-
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 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.
-
resourceTags
public final Map<String,String> resourceTags()
The tags attached to the resource created by Image Builder.
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 tags attached to the resource created by Image Builder.
-
instanceMetadataOptions
public final InstanceMetadataOptions instanceMetadataOptions()
The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
- Returns:
- The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
-
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 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.
-
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.
-
clientToken
public final String clientToken()
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- Returns:
- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
-
toBuilder
public CreateInfrastructureConfigurationRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateInfrastructureConfigurationRequest.Builder,CreateInfrastructureConfigurationRequest>- Specified by:
toBuilderin classImagebuilderRequest
-
builder
public static CreateInfrastructureConfigurationRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateInfrastructureConfigurationRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-