Class: Aws::Imagebuilder::Types::UpdateInfrastructureConfigurationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

Note:

When making an API call, you may pass UpdateInfrastructureConfigurationRequest data as a hash:

{
  infrastructure_configuration_arn: "InfrastructureConfigurationArn", # required
  description: "NonEmptyString",
  instance_types: ["InstanceType"],
  instance_profile_name: "InstanceProfileNameType", # required
  security_group_ids: ["NonEmptyString"],
  subnet_id: "NonEmptyString",
  logging: {
    s3_logs: {
      s3_bucket_name: "NonEmptyString",
      s3_key_prefix: "NonEmptyString",
    },
  },
  key_pair: "NonEmptyString",
  terminate_instance_on_failure: false,
  sns_topic_arn: "SnsTopicArn",
  client_token: "ClientToken", # required
  resource_tags: {
    "TagKey" => "TagValue",
  },
  instance_metadata_options: {
    http_tokens: "HttpTokens",
    http_put_response_hop_limit: 1,
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

The idempotency token used to make this request idempotent.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the infrastructure configuration.

Returns:

  • (String)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#infrastructure_configuration_arnString

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

Returns:

  • (String)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#instance_metadata_optionsTypes::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:



5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#instance_profile_nameString

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

Returns:

  • (String)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typesArray<String>

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:

  • (Array<String>)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#key_pairString

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:

  • (String)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#loggingTypes::Logging

The logging configuration of the infrastructure configuration.

Returns:



5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#resource_tagsHash<String,String>

The tags attached to the resource created by Image Builder.

Returns:

  • (Hash<String,String>)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<String>

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

Returns:

  • (Array<String>)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arnString

The SNS topic on which to send image build events.

Returns:

  • (String)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idString

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

Returns:

  • (String)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end

#terminate_instance_on_failureBoolean

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:

  • (Boolean)


5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 5748

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,
  :sns_topic_arn,
  :client_token,
  :resource_tags,
  :instance_metadata_options)
  SENSITIVE = []
  include Aws::Structure
end