Skip to content

CreateEndpointRequest

Source code in docs_src/capo_s3outposts/types/create_endpoint_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class CreateEndpointRequest(TypedDict, closed=True):
    outpost_id: "capo_s3outposts.types.outpost_id.OutpostId"
    """<p>The ID of the Outposts. </p>"""
    subnet_id: "capo_s3outposts.types.subnet_id.SubnetId"
    """<p>The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.</p>"""
    security_group_id: "capo_s3outposts.types.security_group_id.SecurityGroupId"
    """<p>The ID of the security group to use with the endpoint.</p>"""
    access_type: NotRequired[
        "capo_s3outposts.types.endpoint_access_type.EndpointAccessType"
    ]
    """<p>The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose <code>Private</code>. To use the endpoint with an on-premises network, choose <code>CustomerOwnedIp</code>. If you choose <code>CustomerOwnedIp</code>, you must also provide the customer-owned IP address pool (CoIP pool).</p> <note> <p> <code>Private</code> is the default access type value.</p> </note>"""
    customer_owned_ipv4_pool: NotRequired[
        "capo_s3outposts.types.customer_owned_ipv4_pool.CustomerOwnedIpv4Pool"
    ]
    """<p>The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.</p>"""

access_type instance-attribute 

access_type: NotRequired[EndpointAccessType]

The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

customer_owned_ipv4_pool instance-attribute 

customer_owned_ipv4_pool: NotRequired[CustomerOwnedIpv4Pool]

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

outpost_id instance-attribute 

outpost_id: OutpostId

The ID of the Outposts.

security_group_id instance-attribute 

security_group_id: SecurityGroupId

The ID of the security group to use with the endpoint.

subnet_id instance-attribute 

subnet_id: SubnetId

The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.