Class: MintPress::Aws::EC2::Subnet

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb

Properties (Read/Write)

  • #availability_zone ⇒ [String]
    'The Availability Zone or Local Zone for the subnet. Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet. To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide. To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.'

    Property Attributes
    • source"create_subnet"
    • orig_name'availability_zone'
    • create_subnet_prop'availability_zone'
    • read_onlyfalse
    • fromString
    
    
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 30
    
    property :availability_zone, description: 'The Availability Zone or Local Zone for the subnet.
    
    Default: AWS selects one for you. If you create more than one subnet
    in your VPC, we do not necessarily select a different zone for each
    subnet.
    
    To create a subnet in a Local Zone, set this value to the Local Zone
    ID, for example us-west-2-lax-1a. For information about the Regions
    that support Local Zones, see Available Regions in the Amazon
    Elastic Compute Cloud User Guide.
    
    To create a subnet in an Outpost, set this value to the Availability
    Zone for the Outpost and specify the Outpost ARN.', source: "create_subnet", orig_name: 'availability_zone', type: [String], create_subnet_prop: 'availability_zone', read_only: false, from: String
  • #cidr_block ⇒ [String]
    'The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.'

    Property Attributes
    • source"create_subnet"
    • orig_name'cidr_block'
    • create_subnet_prop'cidr_block'
    • read_onlyfalse
    
    
    44
    45
    46
    47
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 44
    
    property :cidr_block, description: 'The IPv4 network range for the subnet, in CIDR notation. For example,
    10.0.0.0/24. We modify the specified CIDR block to its canonical
    form; for example, if you specify 100.68.0.18/18, we modify it to
    100.68.0.0/18.', source: "create_subnet", orig_name: 'cidr_block', type: [String], create_subnet_prop: 'cidr_block', read_only: false
  • #outpost_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.'

    Property Attributes
    • source"create_subnet"
    • orig_name'outpost_arn'
    • create_subnet_prop'outpost_arn'
    • read_onlyfalse
    
    
    53
    54
    55
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 53
    
    property :outpost_arn, description: 'The Amazon Resource Name (ARN) of the Outpost. If you specify an
    Outpost ARN, you must also specify the Availability Zone of the
    Outpost subnet.', source: "create_subnet", orig_name: 'outpost_arn', type: [String], create_subnet_prop: 'outpost_arn', read_only: false
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::EC2::Tag]
    'The tags to assign to the subnet.'

    Property Attributes
    • source"create_subnet"
    • orig_name'tags'
    • create_subnet_prop'tag_specifications'
    • read_onlyfalse
    
    
    58
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 58
    
    property :tags, description: 'The tags to assign to the subnet.', source: "create_subnet", orig_name: 'tags', type: [MintPress::Aws::EC2::Tag], array: false, create_subnet_prop: 'tag_specifications', read_only: false, hash: true
  • #ipv_6_cidr_block ⇒ [String]
    'The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.'

    Property Attributes
    • create_subnet_prop'ipv_6_cidr_block'
    • read_onlyfalse
    • source"create_subnet"
    
    
    59
    60
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 59
    
    property :ipv_6_cidr_block, create_subnet_prop: 'ipv_6_cidr_block', type: [String], read_only: false, source: "create_subnet", description: 'The IPv6 network range for the subnet, in CIDR notation. The subnet
    size must use a /64 prefix length.'
  • #dry_run ⇒ [TrueClass,FalseClass]
    'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'

    Property Attributes
    • create_subnet_prop'dry_run'
    • read_onlyfalse
    • source"create_subnet"
    • delete_subnet_prop'dry_run'
    • describe_subnets_prop'dry_run'
    
    
    61
    62
    63
    64
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 61
    
    property :dry_run, create_subnet_prop: 'dry_run', type: [TrueClass,FalseClass], read_only: false, source: "create_subnet", description: 'Checks whether you have the required permissions for the action,
    without actually making the request, and provides an error response.
    If you have the required permissions, the error response is
    DryRunOperation. Otherwise, it is UnauthorizedOperation.', delete_subnet_prop: 'dry_run', describe_subnets_prop: 'dry_run'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::EC2::Filter]
    'One or more filters. availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name. availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name. available-ip-address-count - The number of IPv4 addresses in the subnet that are available. cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet"s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names. default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz as the filter name. ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet. ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet. ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet. owner-id - The ID of the AWS account that owns the subnet. state - The state of the subnet (pending | available). subnet-arn - The Amazon Resource Name (ARN) of the subnet. subnet-id - The ID of the subnet. tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. vpc-id - The ID of the VPC for the subnet.'

    Property Attributes
    • describe_subnets_prop'filters'
    • source"describe_subnets"
    
    
    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
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 65
    
    property :filters, describe_subnets_prop: 'filters', type: [MintPress::Aws::EC2::Filter], array: false, source: "describe_subnets", description: 'One or more filters.
    
    
    availability-zone - The Availability Zone for the subnet. You can
    also use availabilityZone as the filter name.
    availability-zone-id - The ID of the Availability Zone for the
    subnet. You can also use availabilityZoneId as the filter name.
    available-ip-address-count - The number of IPv4 addresses in the
    subnet that are available.
    cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you
    specify must exactly match the subnet"s CIDR block for information
    to be returned for the subnet. You can also use cidr or
    cidrBlock as the filter names.
    default-for-az - Indicates whether this is the default subnet for
    the Availability Zone. You can also use defaultForAz as the filter
    name.
    ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block
    associated with the subnet.
    ipv6-cidr-block-association.association-id - An association ID for
    an IPv6 CIDR block associated with the subnet.
    ipv6-cidr-block-association.state - The state of an IPv6 CIDR
    block associated with the subnet.
    owner-id - The ID of the AWS account that owns the subnet.
    state - The state of the subnet (pending | available).
    subnet-arn - The Amazon Resource Name (ARN) of the subnet.
    subnet-id - The ID of the subnet.
    tag:<key> - The key/value combination of a tag assigned to
    the resource. Use the tag key in the filter name and the tag value
    as the filter value. For example, to find all resources that have a
    tag with the key Owner and the value TeamA, specify tag:Owner
    for the filter name and TeamA for the filter value.
    tag-key - The key of a tag assigned to the resource. Use this
    filter to find all resources assigned a tag with a specific key,
    regardless of the tag value.
    vpc-id - The ID of the VPC for the subnet.', hash: true
  • #max_results ⇒ [Integer]
    'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'

    Property Attributes
    • describe_subnets_prop'max_results'
    • source"describe_subnets"
    
    
    100
    101
    102
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 100
    
    property :max_results, describe_subnets_prop: 'max_results', type: [Integer], source: "describe_subnets", description: 'The maximum number of results to return with a single call. To
    retrieve the remaining results, make another call with the returned
    nextToken value.'
  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'One or more subnet IDs. Default: Describes all your subnets.'

    Property Attributes
    • read_onlyfalse
    • source"describe_subnets"
    • orig_name'subnet_id'
    • delete_subnet_prop'subnet_id'
    • describe_subnets_prop'subnet_ids'
    • defaultProc.new { self.name }
    
    
    103
    104
    105
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 103
    
    property :id, read_only: false, description: 'One or more subnet IDs.
    
    Default: Describes all your subnets.', source: "describe_subnets", orig_name: 'subnet_id', type: [String], delete_subnet_prop: 'subnet_id', array: false, hash: false, describe_subnets_prop: 'subnet_ids', default: Proc.new { self.name }
  • #instances ⇒ Hash of ⇒ [MintPress::Aws::EC2::Instance]

    Property Attributes
    • disposition:association
    • source"Subnet"
    • orig_name'instances'
    
    
    106
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 106
    
    property :instances, disposition: :association, source: "Subnet", orig_name: 'instances', type: [MintPress::Aws::EC2::Instance], array: false, hash: true
  • #nat_gateways ⇒ Hash of ⇒ [MintPress::Aws::EC2::NatGateway]

    Property Attributes
    • disposition:association
    • source"Subnet"
    • orig_name'nat_gateways'
    
    
    107
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 107
    
    property :nat_gateways, disposition: :association, source: "Subnet", orig_name: 'nat_gateways', type: [MintPress::Aws::EC2::NatGateway], array: false, hash: true
  • #network_interfaces ⇒ Hash of ⇒ [MintPress::Aws::EC2::NetworkInterface]

    Property Attributes
    • disposition:association
    • source"Subnet"
    • orig_name'network_interfaces'
    
    
    108
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 108
    
    property :network_interfaces, disposition: :association, source: "Subnet", orig_name: 'network_interfaces', type: [MintPress::Aws::EC2::NetworkInterface], array: false, hash: true
  • #vpc ⇒ [MintPress::Aws::EC2::Vpc] (Default Value: MintPress::Aws::EC2::Vpc.new)
    'The ID of the VPC.'

    Property Attributes
    • disposition:association
    • source"Subnet"
    • orig_name'vpc'
    • create_subnet_prop'vpc_id'
    • read_onlyfalse
    • defaultMintPress::Aws::EC2::Vpc.new
    • fromString
    
    
    109
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 109
    
    property :vpc, disposition: :association, description: 'The ID of the VPC.', source: "Subnet", orig_name: 'vpc', type: [MintPress::Aws::EC2::Vpc], create_subnet_prop: 'vpc_id', read_only: false, default: MintPress::Aws::EC2::Vpc.new, from: String
  • #name ⇒ String

    Property Attributes
    
    
    111
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 111
    
    property :name, type: String
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead

    Property Attributes
    
    
    115
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 115
    
    property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)

    Property Attributes
    • defaultMintPress::InfrastructureAws::AwsPlatform.new
    
    
    118
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 118
    
    property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #assign_ipv_6_address_on_creation ⇒ [TrueClass,FalseClass]
    'Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'assign_ipv_6_address_on_creation'
    • read_onlytrue
    
    
    29
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 29
    
    property :assign_ipv_6_address_on_creation, disposition: :read_only_attribute, description: 'Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.', source: "Subnet", orig_name: 'assign_ipv_6_address_on_creation', type: [TrueClass,FalseClass], read_only: true
  • #available_ip_address_count ⇒ [Integer]
    'The number of unused private IPv4 addresses in the subnet.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'available_ip_address_count'
    • read_onlytrue
    
    
    43
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 43
    
    property :available_ip_address_count, disposition: :read_only_attribute, description: 'The number of unused private IPv4 addresses in the subnet.', source: "Subnet", orig_name: 'available_ip_address_count', type: [Integer], read_only: true
  • #customer_owned_ipv_4_pool ⇒ [String]
    'The customer-owned IPv4 address pool associated with the subnet.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'customer_owned_ipv_4_pool'
    • read_onlytrue
    
    
    48
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 48
    
    property :customer_owned_ipv_4_pool, disposition: :read_only_attribute, description: 'The customer-owned IPv4 address pool associated with the subnet.', source: "Subnet", orig_name: 'customer_owned_ipv_4_pool', type: [String], read_only: true
  • #default_for_az ⇒ [TrueClass,FalseClass]
    'Indicates whether this is the default subnet for the Availability Zone.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'default_for_az'
    • read_onlytrue
    
    
    49
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 49
    
    property :default_for_az, disposition: :read_only_attribute, description: 'Indicates whether this is the default subnet for the Availability Zone.', source: "Subnet", orig_name: 'default_for_az', type: [TrueClass,FalseClass], read_only: true
  • #ipv_6_cidr_block_association_set ⇒ Hash of ⇒ [MintPress::Aws::EC2::SubnetIpv6CidrBlockAssociation]
    'Information about the IPv6 CIDR blocks associated with the subnet.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'ipv_6_cidr_block_association_set'
    • read_onlytrue
    
    
    50
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 50
    
    property :ipv_6_cidr_block_association_set, disposition: :read_only_attribute, description: 'Information about the IPv6 CIDR blocks associated with the subnet.', source: "Subnet", orig_name: 'ipv_6_cidr_block_association_set', type: [MintPress::Aws::EC2::SubnetIpv6CidrBlockAssociation], array: false, read_only: true, hash: true
  • #map_customer_owned_ip_on_launch ⇒ [TrueClass,FalseClass]
    'Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'map_customer_owned_ip_on_launch'
    • read_onlytrue
    
    
    51
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 51
    
    property :map_customer_owned_ip_on_launch, disposition: :read_only_attribute, description: 'Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.', source: "Subnet", orig_name: 'map_customer_owned_ip_on_launch', type: [TrueClass,FalseClass], read_only: true
  • #map_public_ip_on_launch ⇒ [TrueClass,FalseClass]
    'Indicates whether instances launched in this subnet receive a public IPv4 address.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'map_public_ip_on_launch'
    • read_onlytrue
    
    
    52
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 52
    
    property :map_public_ip_on_launch, disposition: :read_only_attribute, description: 'Indicates whether instances launched in this subnet receive a public IPv4 address.', source: "Subnet", orig_name: 'map_public_ip_on_launch', type: [TrueClass,FalseClass], read_only: true
  • #state ⇒ [String]
    'The current state of the subnet.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'state'
    • read_onlytrue
    
    
    56
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 56
    
    property :state, disposition: :read_only_attribute, description: 'The current state of the subnet.', source: "Subnet", orig_name: 'state', type: [String], read_only: true
  • #subnet_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the subnet.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'subnet_arn'
    • read_onlytrue
    
    
    57
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 57
    
    property :subnet_arn, disposition: :read_only_attribute, description: 'The Amazon Resource Name (ARN) of the subnet.', source: "Subnet", orig_name: 'subnet_arn', type: [String], read_only: true
  • #owner ⇒ [String]
    'The ID of the AWS account that owns the subnet.'

    Property Attributes
    • disposition:read_only_attribute
    • source"Subnet"
    • orig_name'owner_id'
    • read_onlytrue
    
    
    110
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/ec2/subnet.rb', line 110
    
    property :owner, disposition: :read_only_attribute, description: 'The ID of the AWS account that owns the subnet.', source: "Subnet", orig_name: 'owner_id', type: [String], read_only: true

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Subnet

Returns a new instance of Subnet.

Instance Method Details

#createObject

#deleteObject

#delete_cascadeObject

#describeObject