Class: AWSCDK::EC2::CfnInstanceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ec2/cfn_instance_props.rb

Overview

Properties for defining a CfnInstance.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(additional_info: nil, affinity: nil, availability_zone: nil, block_device_mappings: nil, cpu_options: nil, credit_specification: nil, disable_api_termination: nil, ebs_optimized: nil, elastic_gpu_specifications: nil, elastic_inference_accelerators: nil, enclave_options: nil, hibernation_options: nil, host_id: nil, host_resource_group_arn: nil, iam_instance_profile: nil, image_id: nil, instance_initiated_shutdown_behavior: nil, instance_type: nil, ipv6_address_count: nil, ipv6_addresses: nil, kernel_id: nil, key_name: nil, launch_template: nil, license_specifications: nil, metadata_options: nil, monitoring: nil, network_interfaces: nil, placement_group_name: nil, private_dns_name_options: nil, private_ip_address: nil, propagate_tags_to_volume_on_creation: nil, ramdisk_id: nil, security_group_ids: nil, security_groups: nil, source_dest_check: nil, ssm_associations: nil, subnet_id: nil, tags: nil, tenancy: nil, user_data: nil, volumes: nil) ⇒ CfnInstanceProps

Returns a new instance of CfnInstanceProps.

Parameters:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'ec2/cfn_instance_props.rb', line 50

def initialize(additional_info: nil, affinity: nil, availability_zone: nil, block_device_mappings: nil, cpu_options: nil, credit_specification: nil, disable_api_termination: nil, ebs_optimized: nil, elastic_gpu_specifications: nil, elastic_inference_accelerators: nil, enclave_options: nil, hibernation_options: nil, host_id: nil, host_resource_group_arn: nil, iam_instance_profile: nil, image_id: nil, instance_initiated_shutdown_behavior: nil, instance_type: nil, ipv6_address_count: nil, ipv6_addresses: nil, kernel_id: nil, key_name: nil, launch_template: nil, license_specifications: nil, metadata_options: nil, monitoring: nil, network_interfaces: nil, placement_group_name: nil, private_dns_name_options: nil, private_ip_address: nil, propagate_tags_to_volume_on_creation: nil, ramdisk_id: nil, security_group_ids: nil, security_groups: nil, source_dest_check: nil, ssm_associations: nil, subnet_id: nil, tags: nil, tenancy: nil, user_data: nil, volumes: nil)
  @additional_info = additional_info
  Jsii::Type.check_type(@additional_info, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "additionalInfo") unless @additional_info.nil?
  @affinity = affinity
  Jsii::Type.check_type(@affinity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "affinity") unless @affinity.nil?
  @availability_zone = availability_zone
  Jsii::Type.check_type(@availability_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZone") unless @availability_zone.nil?
  @block_device_mappings = block_device_mappings
  Jsii::Type.check_type(@block_device_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkluc3RhbmNlLkJsb2NrRGV2aWNlTWFwcGluZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "blockDeviceMappings") unless @block_device_mappings.nil?
  @cpu_options = cpu_options.is_a?(Hash) ? ::AWSCDK::EC2::CfnInstance::CpuOptionsProperty.new(**cpu_options.transform_keys(&:to_sym)) : cpu_options
  Jsii::Type.check_type(@cpu_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuSW5zdGFuY2UuQ3B1T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "cpuOptions") unless @cpu_options.nil?
  @credit_specification = credit_specification.is_a?(Hash) ? ::AWSCDK::EC2::CfnInstance::CreditSpecificationProperty.new(**credit_specification.transform_keys(&:to_sym)) : credit_specification
  Jsii::Type.check_type(@credit_specification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuSW5zdGFuY2UuQ3JlZGl0U3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "creditSpecification") unless @credit_specification.nil?
  @disable_api_termination = disable_api_termination
  Jsii::Type.check_type(@disable_api_termination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableApiTermination") unless @disable_api_termination.nil?
  @ebs_optimized = ebs_optimized
  Jsii::Type.check_type(@ebs_optimized, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "ebsOptimized") unless @ebs_optimized.nil?
  @elastic_gpu_specifications = elastic_gpu_specifications
  Jsii::Type.check_type(@elastic_gpu_specifications, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkluc3RhbmNlLkVsYXN0aWNHcHVTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "elasticGpuSpecifications") unless @elastic_gpu_specifications.nil?
  @elastic_inference_accelerators = elastic_inference_accelerators
  Jsii::Type.check_type(@elastic_inference_accelerators, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkluc3RhbmNlLkVsYXN0aWNJbmZlcmVuY2VBY2NlbGVyYXRvclByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "elasticInferenceAccelerators") unless @elastic_inference_accelerators.nil?
  @enclave_options = enclave_options.is_a?(Hash) ? ::AWSCDK::EC2::CfnInstance::EnclaveOptionsProperty.new(**enclave_options.transform_keys(&:to_sym)) : enclave_options
  Jsii::Type.check_type(@enclave_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuSW5zdGFuY2UuRW5jbGF2ZU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "enclaveOptions") unless @enclave_options.nil?
  @hibernation_options = hibernation_options.is_a?(Hash) ? ::AWSCDK::EC2::CfnInstance::HibernationOptionsProperty.new(**hibernation_options.transform_keys(&:to_sym)) : hibernation_options
  Jsii::Type.check_type(@hibernation_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuSW5zdGFuY2UuSGliZXJuYXRpb25PcHRpb25zUHJvcGVydHkifV19fQ==")), "hibernationOptions") unless @hibernation_options.nil?
  @host_id = host_id
  Jsii::Type.check_type(@host_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUhvc3RSZWYifV19fQ==")), "hostId") unless @host_id.nil?
  @host_resource_group_arn = host_resource_group_arn
  Jsii::Type.check_type(@host_resource_group_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostResourceGroupArn") unless @host_resource_group_arn.nil?
  @iam_instance_profile = iam_instance_profile
  Jsii::Type.check_type(@iam_instance_profile, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSUluc3RhbmNlUHJvZmlsZVJlZiJ9XX19")), "iamInstanceProfile") unless @iam_instance_profile.nil?
  @image_id = image_id
  Jsii::Type.check_type(@image_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageId") unless @image_id.nil?
  @instance_initiated_shutdown_behavior = instance_initiated_shutdown_behavior
  Jsii::Type.check_type(@instance_initiated_shutdown_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceInitiatedShutdownBehavior") unless @instance_initiated_shutdown_behavior.nil?
  @instance_type = instance_type
  Jsii::Type.check_type(@instance_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceType") unless @instance_type.nil?
  @ipv6_address_count = ipv6_address_count
  Jsii::Type.check_type(@ipv6_address_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ipv6AddressCount") unless @ipv6_address_count.nil?
  @ipv6_addresses = ipv6_addresses
  Jsii::Type.check_type(@ipv6_addresses, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkluc3RhbmNlLkluc3RhbmNlSXB2NkFkZHJlc3NQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "ipv6Addresses") unless @ipv6_addresses.nil?
  @kernel_id = kernel_id
  Jsii::Type.check_type(@kernel_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kernelId") unless @kernel_id.nil?
  @key_name = key_name
  Jsii::Type.check_type(@key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyName") unless @key_name.nil?
  @launch_template = launch_template.is_a?(Hash) ? ::AWSCDK::EC2::CfnInstance::LaunchTemplateSpecificationProperty.new(**launch_template.transform_keys(&:to_sym)) : launch_template
  Jsii::Type.check_type(@launch_template, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuSW5zdGFuY2UuTGF1bmNoVGVtcGxhdGVTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "launchTemplate") unless @launch_template.nil?
  @license_specifications = license_specifications
  Jsii::Type.check_type(@license_specifications, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkluc3RhbmNlLkxpY2Vuc2VTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "licenseSpecifications") unless @license_specifications.nil?
  @metadata_options = metadata_options.is_a?(Hash) ? ::AWSCDK::EC2::CfnInstance::MetadataOptionsProperty.new(**metadata_options.transform_keys(&:to_sym)) : metadata_options
  Jsii::Type.check_type(@metadata_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuSW5zdGFuY2UuTWV0YWRhdGFPcHRpb25zUHJvcGVydHkifV19fQ==")), "metadataOptions") unless @metadata_options.nil?
  @monitoring = monitoring
  Jsii::Type.check_type(@monitoring, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "monitoring") unless @monitoring.nil?
  @network_interfaces = network_interfaces
  Jsii::Type.check_type(@network_interfaces, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkluc3RhbmNlLk5ldHdvcmtJbnRlcmZhY2VQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "networkInterfaces") unless @network_interfaces.nil?
  @placement_group_name = placement_group_name
  Jsii::Type.check_type(@placement_group_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVBsYWNlbWVudEdyb3VwUmVmIn1dfX0=")), "placementGroupName") unless @placement_group_name.nil?
  @private_dns_name_options = private_dns_name_options.is_a?(Hash) ? ::AWSCDK::EC2::CfnInstance::PrivateDNSNameOptionsProperty.new(**private_dns_name_options.transform_keys(&:to_sym)) : private_dns_name_options
  Jsii::Type.check_type(@private_dns_name_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuSW5zdGFuY2UuUHJpdmF0ZURuc05hbWVPcHRpb25zUHJvcGVydHkifV19fQ==")), "privateDnsNameOptions") unless @private_dns_name_options.nil?
  @private_ip_address = private_ip_address
  Jsii::Type.check_type(@private_ip_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateIpAddress") unless @private_ip_address.nil?
  @propagate_tags_to_volume_on_creation = propagate_tags_to_volume_on_creation
  Jsii::Type.check_type(@propagate_tags_to_volume_on_creation, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "propagateTagsToVolumeOnCreation") unless @propagate_tags_to_volume_on_creation.nil?
  @ramdisk_id = ramdisk_id
  Jsii::Type.check_type(@ramdisk_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ramdiskId") unless @ramdisk_id.nil?
  @security_group_ids = security_group_ids
  Jsii::Type.check_type(@security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX2VjMi5JU2VjdXJpdHlHcm91cFJlZiJ9XX19LCJraW5kIjoiYXJyYXkifX0=")), "securityGroupIds") unless @security_group_ids.nil?
  @security_groups = security_groups
  Jsii::Type.check_type(@security_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityGroups") unless @security_groups.nil?
  @source_dest_check = source_dest_check
  Jsii::Type.check_type(@source_dest_check, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "sourceDestCheck") unless @source_dest_check.nil?
  @ssm_associations = ssm_associations
  Jsii::Type.check_type(@ssm_associations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkluc3RhbmNlLlNzbUFzc29jaWF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "ssmAssociations") unless @ssm_associations.nil?
  @subnet_id = subnet_id
  Jsii::Type.check_type(@subnet_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVN1Ym5ldFJlZiJ9XX19")), "subnetId") unless @subnet_id.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @tenancy = tenancy
  Jsii::Type.check_type(@tenancy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tenancy") unless @tenancy.nil?
  @user_data = user_data
  Jsii::Type.check_type(@user_data, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userData") unless @user_data.nil?
  @volumes = volumes
  Jsii::Type.check_type(@volumes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbkluc3RhbmNlLlZvbHVtZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "volumes") unless @volumes.nil?
end

Instance Attribute Details

#additional_info ⇒ String? (readonly)

This property is reserved for internal use.

If you use it, the stack fails with this error: Bad property set: [Testing this property] (Service: AmazonEC2; Status Code: 400; Error Code: InvalidParameterCombination; Request ID: 0XXXXXX-49c7-4b40-8bcc-76885dcXXXXX) .

Returns:

  • (String, nil)

See Also:



141
142
143
 
# File 'ec2/cfn_instance_props.rb', line 141

def additional_info
  @additional_info
end

#affinity ⇒ String? (readonly)

Indicates whether the instance is associated with a dedicated host.

If you want the instance to always restart on the same host on which it was launched, specify host . If you want the instance to restart on any available host, but try to launch onto the last host it ran on (on a best-effort basis), specify default .

Returns:

  • (String, nil)

See Also:



148
149
150
 
# File 'ec2/cfn_instance_props.rb', line 148

def affinity
  @affinity
end

#availability_zone ⇒ String? (readonly)

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

This parameter is not supported by DescribeImageAttribute .

Returns:

  • (String, nil)

See Also:



157
158
159
 
# File 'ec2/cfn_instance_props.rb', line 157

def availability_zone
  @availability_zone
end

#block_device_mappings ⇒ AWSCDK::IResolvable, ... (readonly)

The block device mapping entries that defines the block devices to attach to the instance at launch.

By default, the block devices specified in the block device mapping for the AMI are used. You can override the AMI block device mapping using the instance block device mapping. For the root volume, you can override only the volume size, volume type, volume encryption settings, and the DeleteOnTermination setting.

After the instance is running, you can modify only the DeleteOnTermination parameter for the attached volumes without interrupting the instance. Modifying any other parameter results in instance replacement .

Returns:

See Also:



166
167
168
 
# File 'ec2/cfn_instance_props.rb', line 166

def block_device_mappings
  @block_device_mappings
end

#cpu_options ⇒ AWSCDK::IResolvable, ... (readonly)

The CPU options for the instance.

For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide .

Returns:

See Also:



173
174
175
 
# File 'ec2/cfn_instance_props.rb', line 173

def cpu_options
  @cpu_options
end

#credit_specification ⇒ AWSCDK::IResolvable, ... (readonly)

The credit option for CPU usage of the burstable performance instance.

Valid values are standard and unlimited . To change this attribute after launch, use ModifyInstanceCreditSpecification . For more information, see Burstable performance instances in the Amazon EC2 User Guide .

Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)

For T3 instances with host tenancy, only standard is supported.

Returns:

See Also:



184
185
186
 
# File 'ec2/cfn_instance_props.rb', line 184

def credit_specification
  @credit_specification
end

#disable_api_termination ⇒ Boolean, ... (readonly)

Indicates whether termination protection is enabled for the instance.

The default is false , which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.

Returns:

See Also:



191
192
193
 
# File 'ec2/cfn_instance_props.rb', line 191

def disable_api_termination
  @disable_api_termination
end

#ebs_optimized ⇒ Boolean, ... (readonly)

Indicates whether the instance is optimized for Amazon EBS I/O.

This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

Returns:

See Also:



200
201
202
 
# File 'ec2/cfn_instance_props.rb', line 200

def ebs_optimized
  @ebs_optimized
end

#elastic_gpu_specifications ⇒ AWSCDK::IResolvable, ... (readonly)

An elastic GPU to associate with the instance.

Amazon Elastic Graphics reached end of life on January 8, 2024.

Returns:

See Also:



207
208
209
 
# File 'ec2/cfn_instance_props.rb', line 207

def elastic_gpu_specifications
  @elastic_gpu_specifications
end

#elastic_inference_accelerators ⇒ AWSCDK::IResolvable, ... (readonly)

An elastic inference accelerator to associate with the instance.

Amazon Elastic Inference is no longer available.

Returns:

See Also:



214
215
216
 
# File 'ec2/cfn_instance_props.rb', line 214

def elastic_inference_accelerators
  @elastic_inference_accelerators
end

#enclave_options ⇒ AWSCDK::IResolvable, ... (readonly)

Indicates whether the instance is enabled for AWS Nitro Enclaves.

Returns:

See Also:



219
220
221
 
# File 'ec2/cfn_instance_props.rb', line 219

def enclave_options
  @enclave_options
end

#hibernation_options ⇒ AWSCDK::IResolvable, ... (readonly)

Indicates whether an instance is enabled for hibernation.

This parameter is valid only if the instance meets the hibernation prerequisites . For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide .

You can't enable hibernation and AWS Nitro Enclaves on the same instance.

Returns:

See Also:



228
229
230
 
# File 'ec2/cfn_instance_props.rb', line 228

def hibernation_options
  @hibernation_options
end

#host_id ⇒ String, ... (readonly)

If you specify host for the Affinity property, the ID of a dedicated host that the instance is associated with.

If you don't specify an ID, Amazon EC2 launches the instance onto any available, compatible dedicated host in your account. This type of launch is called an untargeted launch. Note that for untargeted launches, you must have a compatible, dedicated host available to successfully launch instances.

Returns:

See Also:



235
236
237
 
# File 'ec2/cfn_instance_props.rb', line 235

def host_id
  @host_id
end

#host_resource_group_arn ⇒ String? (readonly)

The ARN of the host resource group in which to launch the instances.

If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .

Returns:

  • (String, nil)

See Also:



242
243
244
 
# File 'ec2/cfn_instance_props.rb', line 242

def host_resource_group_arn
  @host_resource_group_arn
end

#iam_instance_profile ⇒ String, ... (readonly)

The name of an IAM instance profile.

To create a new IAM instance profile, use the AWS::IAM::InstanceProfile resource.

Returns:

See Also:



249
250
251
 
# File 'ec2/cfn_instance_props.rb', line 249

def iam_instance_profile
  @iam_instance_profile
end

#image_id ⇒ String? (readonly)

The ID of the AMI.

An AMI ID is required to launch an instance and must be specified here or in a launch template.

Returns:

  • (String, nil)

See Also:



256
257
258
 
# File 'ec2/cfn_instance_props.rb', line 256

def image_id
  @image_id
end

#instance_initiated_shutdown_behavior ⇒ String? (readonly)

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

Returns:

  • (String, nil)

See Also:



263
264
265
 
# File 'ec2/cfn_instance_props.rb', line 263

def instance_initiated_shutdown_behavior
  @instance_initiated_shutdown_behavior
end

#instance_type ⇒ String? (readonly)

The instance type. For more information, see Instance types in the Amazon EC2 User Guide .

When you change your EBS-backed instance type, instance restart or replacement behavior depends on the instance type compatibility between the old and new types. An instance with an instance store volume as the root volume is always replaced. For more information, see Change the instance type in the Amazon EC2 User Guide .

Returns:

  • (String, nil)

See Also:



270
271
272
 
# File 'ec2/cfn_instance_props.rb', line 270

def instance_type
  @instance_type
end

#ipv6_address_count ⇒ Numeric? (readonly)

The number of IPv6 addresses to associate with the primary network interface.

Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

Returns:

  • (Numeric, nil)

See Also:



279
280
281
 
# File 'ec2/cfn_instance_props.rb', line 279

def ipv6_address_count
  @ipv6_address_count
end

#ipv6_addresses ⇒ AWSCDK::IResolvable, ... (readonly)

The IPv6 addresses from the range of the subnet to associate with the primary network interface.

You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

Returns:

See Also:



288
289
290
 
# File 'ec2/cfn_instance_props.rb', line 288

def ipv6_addresses
  @ipv6_addresses
end

#kernel_id ⇒ String? (readonly)

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .

Returns:

  • (String, nil)

See Also:



295
296
297
 
# File 'ec2/cfn_instance_props.rb', line 295

def kernel_id
  @kernel_id
end

#key_name ⇒ String? (readonly)

The name of the key pair. For more information, see Create a key pair for your EC2 instance .

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

Returns:

  • (String, nil)

See Also:



302
303
304
 
# File 'ec2/cfn_instance_props.rb', line 302

def key_name
  @key_name
end

#launch_template ⇒ AWSCDK::IResolvable, ... (readonly)

The launch template.

Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.

Returns:

See Also:



309
310
311
 
# File 'ec2/cfn_instance_props.rb', line 309

def launch_template
  @launch_template
end

#license_specifications ⇒ AWSCDK::IResolvable, ... (readonly)

The license configurations.

Returns:

See Also:



314
315
316
 
# File 'ec2/cfn_instance_props.rb', line 314

def license_specifications
  @license_specifications
end

#metadata_options ⇒ AWSCDK::IResolvable, ... (readonly)

The metadata options for the instance.

Returns:

See Also:



319
320
321
 
# File 'ec2/cfn_instance_props.rb', line 319

def metadata_options
  @metadata_options
end

#monitoring ⇒ Boolean, ... (readonly)

Specifies whether detailed monitoring is enabled for the instance.

Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled. For more information about detailed monitoring, see Enable or turn off detailed monitoring for your instances in the Amazon EC2 User Guide .

Returns:

See Also:



326
327
328
 
# File 'ec2/cfn_instance_props.rb', line 326

def monitoring
  @monitoring
end

#network_interfaces ⇒ AWSCDK::IResolvable, ... (readonly)

The network interfaces to associate with the instance.

If you use this property to point to a network interface, you must terminate the original interface before attaching a new one to allow the update of the instance to succeed.

If this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn Attribute to declare a dependency on the VPC-gateway attachment.

Returns:

See Also:



335
336
337
 
# File 'ec2/cfn_instance_props.rb', line 335

def network_interfaces
  @network_interfaces
end

#placement_group_name ⇒ String, ... (readonly)

The name of an existing placement group that you want to launch the instance into (cluster | partition | spread).

Returns:

See Also:



340
341
342
 
# File 'ec2/cfn_instance_props.rb', line 340

def placement_group_name
  @placement_group_name
end

#private_dns_name_options ⇒ AWSCDK::IResolvable, ... (readonly)

The options for the instance hostname.

Returns:

See Also:



345
346
347
 
# File 'ec2/cfn_instance_props.rb', line 345

def private_dns_name_options
  @private_dns_name_options
end

#private_ip_address ⇒ String? (readonly)

The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.

If you make an update to an instance that requires replacement, you must assign a new private IP address. During a replacement, AWS CloudFormation creates a new instance but doesn't delete the old instance until the stack has successfully updated. If the stack update fails, AWS CloudFormation uses the old instance to roll back the stack to the previous working state. The old and new instances cannot have the same private IP address.

Returns:

  • (String, nil)

See Also:



356
357
358
 
# File 'ec2/cfn_instance_props.rb', line 356

def private_ip_address
  @private_ip_address
end

#propagate_tags_to_volume_on_creation ⇒ Boolean, ... (readonly)

Indicates whether to assign the tags specified in the Tags property to the volumes specified in the BlockDeviceMappings property.

Note that using this feature does not assign the tags to volumes that are created separately and then attached using AWS::EC2::VolumeAttachment .

Returns:

See Also:



363
364
365
 
# File 'ec2/cfn_instance_props.rb', line 363

def propagate_tags_to_volume_on_creation
  @propagate_tags_to_volume_on_creation
end

#ramdisk_id ⇒ String? (readonly)

The ID of the RAM disk to select.

Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide .

Returns:

  • (String, nil)

See Also:



372
373
374
 
# File 'ec2/cfn_instance_props.rb', line 372

def ramdisk_id
  @ramdisk_id
end

#security_group_ids ⇒ Array<String, AWSCDK::Interfaces::AWSEC2::ISecurityGroupRef>? (readonly)

The IDs of the security groups.

You can specify the IDs of existing security groups and references to resources created by the stack template.

If you specify a network interface, you must specify any security groups as part of the network interface.

Returns:

See Also:



381
382
383
 
# File 'ec2/cfn_instance_props.rb', line 381

def security_group_ids
  @security_group_ids
end

#security_groups ⇒ Array<String>? (readonly)

[Default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

You cannot specify this option and the network interfaces option in the same request. The list can contain both the name of existing Amazon EC2 security groups or references to AWS::EC2::SecurityGroup resources created in the template.

Default: Amazon EC2 uses the default security group.

Returns:

  • (Array<String>, nil)

See Also:



390
391
392
 
# File 'ec2/cfn_instance_props.rb', line 390

def security_groups
  @security_groups
end

#source_dest_check ⇒ Boolean, ... (readonly)

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

If the value is true , source/destination checks are enabled; otherwise, they are disabled. The default value is true . You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

Returns:

See Also:



397
398
399
 
# File 'ec2/cfn_instance_props.rb', line 397

def source_dest_check
  @source_dest_check
end

#ssm_associations ⇒ AWSCDK::IResolvable, ... (readonly)

The SSM document and parameter values in AWS Systems Manager to associate with this instance. To use this property, you must specify an IAM instance profile role for the instance. For more information, see Create an IAM instance profile for Systems Manager in the AWS Systems Manager User Guide .

You can associate only one document with an instance.

Returns:

See Also:



404
405
406
 
# File 'ec2/cfn_instance_props.rb', line 404

def ssm_associations
  @ssm_associations
end

#subnet_id ⇒ String, ... (readonly)

The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.

Returns:

See Also:



411
412
413
 
# File 'ec2/cfn_instance_props.rb', line 411

def subnet_id
  @subnet_id
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags to add to the instance.

These tags are not applied to the EBS volumes, such as the root volume, unless PropagateTagsToVolumeOnCreation is true .

Returns:

See Also:



418
419
420
 
# File 'ec2/cfn_instance_props.rb', line 418

def tags
  @tags
end

#tenancy ⇒ String? (readonly)

The tenancy of the instance.

An instance with a tenancy of dedicated runs on single-tenant hardware.

Returns:

  • (String, nil)

See Also:



425
426
427
 
# File 'ec2/cfn_instance_props.rb', line 425

def tenancy
  @tenancy
end

#user_data ⇒ String? (readonly)

The parameters or scripts to store as user data.

Any scripts in user data are run when you launch the instance. User data is limited to 16 KB. You must provide base64-encoded text. For more information, see Fn::Base64 .

If the root volume is an EBS volume and you update user data, CloudFormation restarts the instance. If the root volume is an instance store volume and you update user data, the instance is replaced.

Returns:

  • (String, nil)

See Also:



434
435
436
 
# File 'ec2/cfn_instance_props.rb', line 434

def user_data
  @user_data
end

#volumes ⇒ AWSCDK::IResolvable, ... (readonly)

The volumes to attach to the instance.

Returns:

See Also:



439
440
441
 
# File 'ec2/cfn_instance_props.rb', line 439

def volumes
  @volumes
end

Class Method Details

.jsii_properties ⇒ Object 



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'ec2/cfn_instance_props.rb', line 441

def self.jsii_properties
  {
    :additional_info => "additionalInfo",
    :affinity => "affinity",
    :availability_zone => "availabilityZone",
    :block_device_mappings => "blockDeviceMappings",
    :cpu_options => "cpuOptions",
    :credit_specification => "creditSpecification",
    :disable_api_termination => "disableApiTermination",
    :ebs_optimized => "ebsOptimized",
    :elastic_gpu_specifications => "elasticGpuSpecifications",
    :elastic_inference_accelerators => "elasticInferenceAccelerators",
    :enclave_options => "enclaveOptions",
    :hibernation_options => "hibernationOptions",
    :host_id => "hostId",
    :host_resource_group_arn => "hostResourceGroupArn",
    :iam_instance_profile => "iamInstanceProfile",
    :image_id => "imageId",
    :instance_initiated_shutdown_behavior => "instanceInitiatedShutdownBehavior",
    :instance_type => "instanceType",
    :ipv6_address_count => "ipv6AddressCount",
    :ipv6_addresses => "ipv6Addresses",
    :kernel_id => "kernelId",
    :key_name => "keyName",
    :launch_template => "launchTemplate",
    :license_specifications => "licenseSpecifications",
    :metadata_options => "metadataOptions",
    :monitoring => "monitoring",
    :network_interfaces => "networkInterfaces",
    :placement_group_name => "placementGroupName",
    :private_dns_name_options => "privateDnsNameOptions",
    :private_ip_address => "privateIpAddress",
    :propagate_tags_to_volume_on_creation => "propagateTagsToVolumeOnCreation",
    :ramdisk_id => "ramdiskId",
    :security_group_ids => "securityGroupIds",
    :security_groups => "securityGroups",
    :source_dest_check => "sourceDestCheck",
    :ssm_associations => "ssmAssociations",
    :subnet_id => "subnetId",
    :tags => "tags",
    :tenancy => "tenancy",
    :user_data => "userData",
    :volumes => "volumes",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'ec2/cfn_instance_props.rb', line 487

def to_jsii
  result = {}
  result.merge!({
    "additionalInfo" => @additional_info,
    "affinity" => @affinity,
    "availabilityZone" => @availability_zone,
    "blockDeviceMappings" => @block_device_mappings,
    "cpuOptions" => @cpu_options,
    "creditSpecification" => @credit_specification,
    "disableApiTermination" => @disable_api_termination,
    "ebsOptimized" => @ebs_optimized,
    "elasticGpuSpecifications" => @elastic_gpu_specifications,
    "elasticInferenceAccelerators" => @elastic_inference_accelerators,
    "enclaveOptions" => @enclave_options,
    "hibernationOptions" => @hibernation_options,
    "hostId" => @host_id,
    "hostResourceGroupArn" => @host_resource_group_arn,
    "iamInstanceProfile" => @iam_instance_profile,
    "imageId" => @image_id,
    "instanceInitiatedShutdownBehavior" => @instance_initiated_shutdown_behavior,
    "instanceType" => @instance_type,
    "ipv6AddressCount" => @ipv6_address_count,
    "ipv6Addresses" => @ipv6_addresses,
    "kernelId" => @kernel_id,
    "keyName" => @key_name,
    "launchTemplate" => @launch_template,
    "licenseSpecifications" => @license_specifications,
    "metadataOptions" => @metadata_options,
    "monitoring" => @monitoring,
    "networkInterfaces" => @network_interfaces,
    "placementGroupName" => @placement_group_name,
    "privateDnsNameOptions" => @private_dns_name_options,
    "privateIpAddress" => @private_ip_address,
    "propagateTagsToVolumeOnCreation" => @propagate_tags_to_volume_on_creation,
    "ramdiskId" => @ramdisk_id,
    "securityGroupIds" => @security_group_ids,
    "securityGroups" => @security_groups,
    "sourceDestCheck" => @source_dest_check,
    "ssmAssociations" => @ssm_associations,
    "subnetId" => @subnet_id,
    "tags" => @tags,
    "tenancy" => @tenancy,
    "userData" => @user_data,
    "volumes" => @volumes,
  })
  result.compact
end