Class: Aws::Imagebuilder::Types::UpdateInfrastructureConfigurationRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Imagebuilder::Types::UpdateInfrastructureConfigurationRequest
- Defined in:
- gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_token ⇒ String
A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time.
-
#description ⇒ String
The description of the infrastructure configuration.
-
#infrastructure_configuration_arn ⇒ String
The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
-
#instance_metadata_options ⇒ Types::InstanceMetadataOptions
The instance metadata service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches during image creation.
-
#instance_profile_name ⇒ String
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
-
#instance_types ⇒ Array<String>
The instance types of the infrastructure configuration.
-
#key_pair ⇒ String
The key pair of the infrastructure configuration.
-
#logging ⇒ Types::Logging
The logging configuration of the infrastructure configuration.
-
#parent_instance ⇒ Types::ParentInstanceConfiguration
The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of launching a new instance.
-
#placement ⇒ Types::Placement
The instance placement settings that define where the build and test instances that Image Builder launches during image creation run.
-
#resource_tags ⇒ Hash<String,String>
The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.
-
#security_group_ids ⇒ Array<String>
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
-
#sns_topic_arn ⇒ String
The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications.
-
#subnet_id ⇒ String
The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
-
#terminate_instance_on_completion ⇒ Boolean
Specifies whether Image Builder terminates build and test instances when image creation ends without a failure (success, cancellation, or expiration).
-
#terminate_instance_on_failure ⇒ Boolean
Specifies whether to terminate the instance on failure.
Instance Attribute Details
#client_token ⇒ String
A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
A suitable default value is auto-generated. You should normally not need to pass this option.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the infrastructure configuration.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#infrastructure_configuration_arn ⇒ String
The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#instance_metadata_options ⇒ Types::InstanceMetadataOptions
The instance metadata service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches during image creation. If you don't set these options, the EC2 launch defaults for the instance apply. 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.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#instance_profile_name ⇒ String
The instance profile to associate with the instance used to customize your Amazon EC2 AMI. The instance profile must exist in your account.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#instance_types ⇒ Array<String>
The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. Image Builder picks one of these instance types based on availability. If you don't specify instance types, Image Builder selects compatible instance types automatically. If you specify a Dedicated Host, Image Builder uses only instance types that the host supports.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#key_pair ⇒ String
The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#logging ⇒ Types::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.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#parent_instance ⇒ Types::ParentInstanceConfiguration
The Amazon EC2 Auto Scaling group that Image Builder takes the build instance from, instead of launching a new instance. This applies only to the build phase.
To use this feature, the execution role for the build must have permissions to describe the Auto Scaling group, tag the instance while it's still in the group, and detach it from the group. For more information, see Build on an instance from an Auto Scaling group in the EC2 Image Builder User Guide.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#placement ⇒ Types::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.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#resource_tags ⇒ Hash<String,String>
The metadata tags to assign to the Amazon EC2 instance that Image
Builder launches during the build process. Tags are formatted as key
value pairs. Tag keys can't begin with aws: or match one of the
following reserved keys: CreatedBy, Ec2ImageBuilderArn, Name,
or Tags.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#security_group_ids ⇒ Array<String>
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#sns_topic_arn ⇒ String
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. Image Builder validates the topic when you create or update the configuration. You must have permission to publish to the topic.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#subnet_id ⇒ String
The subnet ID in which to place the instance used to customize your
Amazon EC2 AMI. If you specify subnetId, you must also specify one
or more security group IDs in securityGroupIds. Otherwise, the
request fails.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#terminate_instance_on_completion ⇒ Boolean
Specifies whether Image Builder terminates build and test instances
when image creation ends without a failure (success, cancellation,
or expiration). Defaults to true.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |
#terminate_instance_on_failure ⇒ Boolean
Specifies whether to terminate the instance on failure. 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. Defaults
to true.
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 |
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 9859 class UpdateInfrastructureConfigurationRequest < Struct.new( :infrastructure_configuration_arn, :description, :instance_types, :instance_profile_name, :security_group_ids, :subnet_id, :logging, :key_pair, :terminate_instance_on_failure, :terminate_instance_on_completion, :sns_topic_arn, :resource_tags, :instance_metadata_options, :placement, :parent_instance, :client_token) SENSITIVE = [] include Aws::Structure end |