software.amazon.awssdk.services.imagebuilder.model

Class UpdateInfrastructureConfigurationRequest

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.UpdateInfrastructureConfigurationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateInfrastructureConfigurationRequest.Builder,UpdateInfrastructureConfigurationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateInfrastructureConfigurationRequest
extends ImagebuilderRequest
implements ToCopyableBuilder<UpdateInfrastructureConfigurationRequest.Builder,UpdateInfrastructureConfigurationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateInfrastructureConfigurationRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateInfrastructureConfigurationRequest.Builder	builder()
String	clientToken() The idempotency token used to make this request idempotent.
String	description() The description of the infrastructure configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasInstanceTypes() For responses, this returns true if the service returned a value for the InstanceTypes property.
boolean	hasResourceTags() For responses, this returns true if the service returned a value for the ResourceTags property.
boolean	hasSecurityGroupIds() For responses, this returns true if the service returned a value for the SecurityGroupIds property.
String	infrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
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.
String	instanceProfileName() 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.
String	keyPair() The key pair of the infrastructure configuration.
Logging	logging() The logging configuration 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 UpdateInfrastructureConfigurationRequest.Builder>	serializableBuilderClass()
String	snsTopicArn() The SNS topic on which to send image build events.
String	subnetId() The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
Boolean	terminateInstanceOnFailure() The terminate instance on failure setting of the infrastructure configuration.
UpdateInfrastructureConfigurationRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

infrastructureConfigurationArn

public final String 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

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. 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 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 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 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

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 SNS topic on which to send image build events.

Returns:

The SNS topic on which to send image build events.

clientToken

public final String clientToken()

The idempotency token used to make this request idempotent.

Returns:

The idempotency token used to make this request idempotent.

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 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. 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

public UpdateInfrastructureConfigurationRequest.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<UpdateInfrastructureConfigurationRequest.Builder,UpdateInfrastructureConfigurationRequest>

Specified by:

toBuilder in class ImagebuilderRequest

Returns:

a builder for type T

builder

public static UpdateInfrastructureConfigurationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateInfrastructureConfigurationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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

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.