CfnEndpointProps

class aws_cdk.aws_s3outposts.CfnEndpointProps(*, outpost_id, security_group_id, subnet_id, access_type=None, customer_owned_ipv4_pool=None, failed_reason=None)

Bases: object

Properties for defining a CfnEndpoint.

Parameters:

  • outpost_id (str) – The ID of the Outpost.

  • security_group_id (str) – The ID of the security group used for the endpoint.

  • subnet_id (str) – The ID of the subnet used for the endpoint.

  • access_type (Optional[str]) – The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint. To use the Amazon 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). .. epigraph:: Private is the default access type value. Default: - “Private”

  • customer_owned_ipv4_pool (Optional[str]) – The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

  • failed_reason (Union[IResolvable, FailedReasonProperty, Dict[str, Any], None]) – The failure reason, if any, for a create or delete endpoint operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3outposts as s3outposts

cfn_endpoint_props = s3outposts.CfnEndpointProps(
    outpost_id="outpostId",
    security_group_id="securityGroupId",
    subnet_id="subnetId",

    # the properties below are optional
    access_type="accessType",
    customer_owned_ipv4_pool="customerOwnedIpv4Pool",
    failed_reason=s3outposts.CfnEndpoint.FailedReasonProperty(
        error_code="errorCode",
        message="message"
    )
)

Attributes

access_type

The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.

To use the Amazon 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). .. epigraph:

``Private`` is the default access type value.
Default:

  • “Private”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-accesstype

customer_owned_ipv4_pool

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.

IP addresses are allocated from this pool for the endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-customerownedipv4pool

failed_reason

The failure reason, if any, for a create or delete endpoint operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-failedreason

outpost_id

The ID of the Outpost.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-outpostid

security_group_id

The ID of the security group used for the endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-securitygroupid

subnet_id

The ID of the subnet used for the endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3outposts-endpoint.html#cfn-s3outposts-endpoint-subnetid