Class UpdateInfrastructureConfigurationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateInfrastructureConfigurationRequest.Builder,
UpdateInfrastructureConfigurationRequest>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Unique, case-sensitive identifier you provide to ensure idempotency of the request.final String
The description of the infrastructure 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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InstanceTypes property.final boolean
For responses, this returns true if the service returned a value for the ResourceTags property.final boolean
For responses, this returns true if the service returned a value for the SecurityGroupIds property.final String
The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.final InstanceMetadataOptions
The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.final String
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.The instance types of the infrastructure configuration.final String
keyPair()
The key pair of the infrastructure configuration.final Logging
logging()
The logging configuration of the infrastructure configuration.The tags attached to the resource created by Image Builder.The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.static Class
<? extends UpdateInfrastructureConfigurationRequest.Builder> final String
The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.final String
subnetId()
The subnet ID to place the instance used to customize your Amazon EC2 AMI in.final Boolean
The terminate instance on failure setting of the infrastructure configuration.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
infrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
- Returns:
- The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
-
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
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
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
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
The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
- Returns:
- The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
-
logging
The logging configuration of the infrastructure configuration.
- Returns:
- The logging configuration of the infrastructure configuration.
-
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
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
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.
-
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.
-
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
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
The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see one of the following links:
-
Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.
-
Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows 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. For more information about instance metadata options, see one of the
following links:
-
Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.
-
Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows 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<UpdateInfrastructureConfigurationRequest.Builder,
UpdateInfrastructureConfigurationRequest> - Specified by:
toBuilder
in classImagebuilderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends UpdateInfrastructureConfigurationRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-