modify_subnet_attribute ¶

def modify_subnet_attribute(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    assign_ipv6_address_on_creation: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    map_public_ip_on_launch: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    subnet_id: Optional["capo_ec2.types.subnet_id.SubnetId"] = None,
    map_customer_owned_ip_on_launch: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    customer_owned_ipv4_pool: Optional[
        "capo_ec2.types.coip_pool_id.CoipPoolId"
    ] = None,
    enable_dns64: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    private_dns_hostname_type_on_launch: Optional[
        "capo_ec2.types.hostname_type.HostnameType"
    ] = None,
    enable_resource_name_dns_a_record_on_launch: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    enable_resource_name_dns_aaaa_record_on_launch: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    enable_lni_at_device_index: Optional["capo_ec2.types.integer.Integer"] = None,
    disable_lni_at_device_index: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
) -> None:
    """<p>Modifies a subnet attribute. You can only modify one attribute at a time.</p> <p>Use this action to modify subnets on Amazon Web Services Outposts.</p> <ul> <li> <p>To modify a subnet on an Outpost rack, set both <code>MapCustomerOwnedIpOnLaunch</code> and <code>CustomerOwnedIpv4Pool</code>. These two parameters act as a single attribute.</p> </li> <li> <p>To modify a subnet on an Outpost server, set either <code>EnableLniAtDeviceIndex</code> or <code>DisableLniAtDeviceIndex</code>.</p> </li> </ul> <p>For more information about Amazon Web Services Outposts, see the following:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/outposts/latest/userguide/how-servers-work.html">Outpost servers</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/outposts/latest/userguide/how-racks-work.html">Outpost racks</a> </p> </li> </ul>

    Args:
        assign_ipv6_address_on_creation: <p>Specify <code>true</code> to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address). </p> <p>If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version <code>2016-11-15</code> or later of the Amazon EC2 API.</p>
        map_public_ip_on_launch: <p>Specify <code>true</code> to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.</p> <p>Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the <i>Public IPv4 Address</i> tab on the <a href="http://aws.amazon.com/vpc/pricing/">Amazon VPC pricing page</a>.</p>
        subnet_id: <p>The ID of the subnet.</p>
        map_customer_owned_ip_on_launch: <p>Specify <code>true</code> to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.</p> <p>When this value is <code>true</code>, you must specify the customer-owned IP pool using <code>CustomerOwnedIpv4Pool</code>.</p>
        customer_owned_ipv4_pool: <p>The customer-owned IPv4 address pool associated with the subnet.</p> <p>You must set this value when you specify <code>true</code> for <code>MapCustomerOwnedIpOnLaunch</code>.</p>
        enable_dns64: <p>Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.</p> <p>You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a <code>0.0.0.0/0</code> route pointing to the internet gateway. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough">Configure DNS64 and NAT64</a> in the <i>Amazon VPC User Guide</i>.</p>
        private_dns_hostname_type_on_launch: <p>The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).</p>
        enable_resource_name_dns_a_record_on_launch: <p>Indicates whether to respond to DNS queries for instance hostnames with DNS A records.</p>
        enable_resource_name_dns_aaaa_record_on_launch: <p>Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.</p>
        enable_lni_at_device_index: <p> Indicates the device position for local network interfaces in this subnet. For example, <code>1</code> indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0). </p>
        disable_lni_at_device_index: <p> Specify <code>true</code> to indicate that local network interfaces at the current position should be disabled. </p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To change a subnet's public IP addressing behavior
        This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.

        >>> client.modify_subnet_attribute(subnet_id='subnet-1a2b3c4d', map_public_ip_on_launch={'Value': True})
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.modify_subnet_attribute_request.ModifySubnetAttributeRequest]",
    ) -> OperationResponse[None]:
        import capo_ec2._operations.amazon_ec2.modify_subnet_attribute

        output, http_response = (
            capo_ec2._operations.amazon_ec2.modify_subnet_attribute.modify_subnet_attribute(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifySubnetAttribute")
    )
    input_: capo_ec2.types.modify_subnet_attribute_request.ModifySubnetAttributeRequest = {}
    if assign_ipv6_address_on_creation is not None:
        input_["assign_ipv6_address_on_creation"] = assign_ipv6_address_on_creation
    if map_public_ip_on_launch is not None:
        input_["map_public_ip_on_launch"] = map_public_ip_on_launch
    if subnet_id is not None:
        input_["subnet_id"] = subnet_id
    if map_customer_owned_ip_on_launch is not None:
        input_["map_customer_owned_ip_on_launch"] = map_customer_owned_ip_on_launch
    if customer_owned_ipv4_pool is not None:
        input_["customer_owned_ipv4_pool"] = customer_owned_ipv4_pool
    if enable_dns64 is not None:
        input_["enable_dns64"] = enable_dns64
    if private_dns_hostname_type_on_launch is not None:
        input_["private_dns_hostname_type_on_launch"] = (
            private_dns_hostname_type_on_launch
        )
    if enable_resource_name_dns_a_record_on_launch is not None:
        input_["enable_resource_name_dns_a_record_on_launch"] = (
            enable_resource_name_dns_a_record_on_launch
        )
    if enable_resource_name_dns_aaaa_record_on_launch is not None:
        input_["enable_resource_name_dns_aaaa_record_on_launch"] = (
            enable_resource_name_dns_aaaa_record_on_launch
        )
    if enable_lni_at_device_index is not None:
        input_["enable_lni_at_device_index"] = enable_lni_at_device_index
    if disable_lni_at_device_index is not None:
        input_["disable_lni_at_device_index"] = disable_lni_at_device_index

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output