com.amazonaws.services.imagebuilder.model

Class UpdateInfrastructureConfigurationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.imagebuilder.model.UpdateInfrastructureConfigurationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateInfrastructureConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateInfrastructureConfigurationRequest()

Method Summary

Modifier and Type	Method and Description
UpdateInfrastructureConfigurationRequest	addResourceTagsEntry(String key, String value) Add a single ResourceTags entry
UpdateInfrastructureConfigurationRequest	clearResourceTagsEntries() Removes all the entries added into ResourceTags.
UpdateInfrastructureConfigurationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
String	getDescription() The description of the infrastructure configuration.
String	getInfrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
InstanceMetadataOptions	getInstanceMetadataOptions() The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
String	getInstanceProfileName() The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
List<String>	getInstanceTypes() The instance types of the infrastructure configuration.
String	getKeyPair() The key pair of the infrastructure configuration.
Logging	getLogging() The logging configuration of the infrastructure configuration.
Map<String,String>	getResourceTags() The tags attached to the resource created by Image Builder.
List<String>	getSecurityGroupIds() The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
String	getSnsTopicArn() The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
String	getSubnetId() The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
Boolean	getTerminateInstanceOnFailure() The terminate instance on failure setting of the infrastructure configuration.
int	hashCode()
Boolean	isTerminateInstanceOnFailure() The terminate instance on failure setting of the infrastructure configuration.
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
void	setDescription(String description) The description of the infrastructure configuration.
void	setInfrastructureConfigurationArn(String infrastructureConfigurationArn) The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
void	setInstanceMetadataOptions(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.
void	setInstanceProfileName(String instanceProfileName) The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
void	setInstanceTypes(Collection<String> instanceTypes) The instance types of the infrastructure configuration.
void	setKeyPair(String keyPair) The key pair of the infrastructure configuration.
void	setLogging(Logging logging) The logging configuration of the infrastructure configuration.
void	setResourceTags(Map<String,String> resourceTags) The tags attached to the resource created by Image Builder.
void	setSecurityGroupIds(Collection<String> securityGroupIds) The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
void	setSnsTopicArn(String snsTopicArn) The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
void	setSubnetId(String subnetId) The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
void	setTerminateInstanceOnFailure(Boolean terminateInstanceOnFailure) The terminate instance on failure setting of the infrastructure configuration.
String	toString() Returns a string representation of this object.
UpdateInfrastructureConfigurationRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
UpdateInfrastructureConfigurationRequest	withDescription(String description) The description of the infrastructure configuration.
UpdateInfrastructureConfigurationRequest	withInfrastructureConfigurationArn(String infrastructureConfigurationArn) The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
UpdateInfrastructureConfigurationRequest	withInstanceMetadataOptions(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.
UpdateInfrastructureConfigurationRequest	withInstanceProfileName(String instanceProfileName) The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
UpdateInfrastructureConfigurationRequest	withInstanceTypes(Collection<String> instanceTypes) The instance types of the infrastructure configuration.
UpdateInfrastructureConfigurationRequest	withInstanceTypes(String... instanceTypes) The instance types of the infrastructure configuration.
UpdateInfrastructureConfigurationRequest	withKeyPair(String keyPair) The key pair of the infrastructure configuration.
UpdateInfrastructureConfigurationRequest	withLogging(Logging logging) The logging configuration of the infrastructure configuration.
UpdateInfrastructureConfigurationRequest	withResourceTags(Map<String,String> resourceTags) The tags attached to the resource created by Image Builder.
UpdateInfrastructureConfigurationRequest	withSecurityGroupIds(Collection<String> securityGroupIds) The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
UpdateInfrastructureConfigurationRequest	withSecurityGroupIds(String... securityGroupIds) The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
UpdateInfrastructureConfigurationRequest	withSnsTopicArn(String snsTopicArn) The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
UpdateInfrastructureConfigurationRequest	withSubnetId(String subnetId) The subnet ID to place the instance used to customize your Amazon EC2 AMI in.
UpdateInfrastructureConfigurationRequest	withTerminateInstanceOnFailure(Boolean terminateInstanceOnFailure) The terminate instance on failure setting of the infrastructure configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateInfrastructureConfigurationRequest

public UpdateInfrastructureConfigurationRequest()

Method Detail

setInfrastructureConfigurationArn

public void setInfrastructureConfigurationArn(String infrastructureConfigurationArn)

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

Parameters:

infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

getInfrastructureConfigurationArn

public String getInfrastructureConfigurationArn()

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.

withInfrastructureConfigurationArn

public UpdateInfrastructureConfigurationRequest withInfrastructureConfigurationArn(String infrastructureConfigurationArn)

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

Parameters:

infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description of the infrastructure configuration.

Parameters:

description - The description of the infrastructure configuration.

getDescription

public String getDescription()

The description of the infrastructure configuration.

Returns:

The description of the infrastructure configuration.

withDescription

public UpdateInfrastructureConfigurationRequest withDescription(String description)

The description of the infrastructure configuration.

Parameters:

description - The description of the infrastructure configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

getInstanceTypes

public List<String> getInstanceTypes()

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.

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.

setInstanceTypes

public void setInstanceTypes(Collection<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.

Parameters:

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.

withInstanceTypes

public UpdateInfrastructureConfigurationRequest withInstanceTypes(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.

NOTE: This method appends the values to the existing list (if any). Use setInstanceTypes(java.util.Collection) or withInstanceTypes(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withInstanceTypes

public UpdateInfrastructureConfigurationRequest withInstanceTypes(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceProfileName

public void setInstanceProfileName(String instanceProfileName)

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

Parameters:

instanceProfileName - The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

getInstanceProfileName

public String getInstanceProfileName()

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.

withInstanceProfileName

public UpdateInfrastructureConfigurationRequest withInstanceProfileName(String instanceProfileName)

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

Parameters:

instanceProfileName - The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSecurityGroupIds

public List<String> getSecurityGroupIds()

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

Returns:

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

setSecurityGroupIds

public void setSecurityGroupIds(Collection<String> securityGroupIds)

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

Parameters:

securityGroupIds - The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

withSecurityGroupIds

public UpdateInfrastructureConfigurationRequest withSecurityGroupIds(String... securityGroupIds)

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

Parameters:

securityGroupIds - The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSecurityGroupIds

public UpdateInfrastructureConfigurationRequest withSecurityGroupIds(Collection<String> securityGroupIds)

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

Parameters:

securityGroupIds - The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSubnetId

public void setSubnetId(String subnetId)

The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

Parameters:

subnetId - The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

getSubnetId

public String getSubnetId()

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.

withSubnetId

public UpdateInfrastructureConfigurationRequest withSubnetId(String subnetId)

The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

Parameters:

subnetId - The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLogging

public void setLogging(Logging logging)

The logging configuration of the infrastructure configuration.

Parameters:

logging - The logging configuration of the infrastructure configuration.

getLogging

public Logging getLogging()

The logging configuration of the infrastructure configuration.

Returns:

The logging configuration of the infrastructure configuration.

withLogging

public UpdateInfrastructureConfigurationRequest withLogging(Logging logging)

The logging configuration of the infrastructure configuration.

Parameters:

logging - The logging configuration of the infrastructure configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKeyPair

public void setKeyPair(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.

Parameters:

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.

getKeyPair

public String getKeyPair()

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.

withKeyPair

public UpdateInfrastructureConfigurationRequest withKeyPair(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTerminateInstanceOnFailure

public void setTerminateInstanceOnFailure(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.

Parameters:

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.

getTerminateInstanceOnFailure

public Boolean getTerminateInstanceOnFailure()

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.

withTerminateInstanceOnFailure

public UpdateInfrastructureConfigurationRequest withTerminateInstanceOnFailure(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isTerminateInstanceOnFailure

public Boolean isTerminateInstanceOnFailure()

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.

setSnsTopicArn

public void setSnsTopicArn(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.

Parameters:

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.

getSnsTopicArn

public String getSnsTopicArn()

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.

withSnsTopicArn

public UpdateInfrastructureConfigurationRequest withSnsTopicArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

withClientToken

public UpdateInfrastructureConfigurationRequest withClientToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getResourceTags

public Map<String,String> getResourceTags()

The tags attached to the resource created by Image Builder.

Returns:

The tags attached to the resource created by Image Builder.

setResourceTags

public void setResourceTags(Map<String,String> resourceTags)

The tags attached to the resource created by Image Builder.

Parameters:

resourceTags - The tags attached to the resource created by Image Builder.

withResourceTags

public UpdateInfrastructureConfigurationRequest withResourceTags(Map<String,String> resourceTags)

The tags attached to the resource created by Image Builder.

Parameters:

resourceTags - The tags attached to the resource created by Image Builder.

Returns:

Returns a reference to this object so that method calls can be chained together.

addResourceTagsEntry

public UpdateInfrastructureConfigurationRequest addResourceTagsEntry(String key,
                                                                     String value)

Add a single ResourceTags entry

See Also:

withResourceTags(java.util.Map<java.lang.String, java.lang.String>)

clearResourceTagsEntries

public UpdateInfrastructureConfigurationRequest clearResourceTagsEntries()

Removes all the entries added into ResourceTags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceMetadataOptions

public void setInstanceMetadataOptions(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.

Parameters:

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.

getInstanceMetadataOptions

public InstanceMetadataOptions getInstanceMetadataOptions()

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.

withInstanceMetadataOptions

public UpdateInfrastructureConfigurationRequest withInstanceMetadataOptions(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateInfrastructureConfigurationRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()