Interface ICfnEndpointProps

Properties for defining a CfnEndpoint.

Namespace: Amazon.CDK.AWS.S3Outposts

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnEndpointProps

Syntax (vb)

Public Interface ICfnEndpointProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3Outposts;

             var cfnEndpointProps = new CfnEndpointProps {
                 OutpostId = "outpostId",
                 SecurityGroupId = "securityGroupId",
                 SubnetId = "subnetId",

                 // the properties below are optional
                 AccessType = "accessType",
                 CustomerOwnedIpv4Pool = "customerOwnedIpv4Pool",
                 FailedReason = new FailedReasonProperty {
                     ErrorCode = "errorCode",
                     Message = "message"
                 }
             };

Synopsis

Properties

AccessType	The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
CustomerOwnedIpv4Pool	The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
FailedReason	The failure reason, if any, for a create or delete endpoint operation.
OutpostId	The ID of the Outpost.
SecurityGroupId	The ID of the security group used for the endpoint.
SubnetId	The ID of the subnet used for the endpoint.

Properties

AccessType

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

string? AccessType { get; }

Property Value

string

Remarks

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).

<code>Private</code> 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

CustomerOwnedIpv4Pool

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

string? CustomerOwnedIpv4Pool { get; }

Property Value

string

Remarks

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

FailedReason

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

object? FailedReason { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnEndpoint.IFailedReasonProperty

OutpostId

The ID of the Outpost.

string OutpostId { get; }

Property Value

string

Remarks

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

SecurityGroupId

The ID of the security group used for the endpoint.

string SecurityGroupId { get; }

Property Value

string

Remarks

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

SubnetId

The ID of the subnet used for the endpoint.

string SubnetId { get; }

Property Value

string

Remarks

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