Class CfnEndpoint
A CloudFormation AWS::S3Outposts::Endpoint
.
Inherited Members
Namespace: Amazon.CDK.AWS.S3Outposts
Assembly: Amazon.CDK.AWS.S3Outposts.dll
Syntax (csharp)
public class CfnEndpoint : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEndpoint
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
This AWS::S3Outposts::Endpoint resource specifies an endpoint and associates it with the specified Outpost.
Amazon S3 on Outposts access points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to S3 on Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC-only access points .
It can take up to 5 minutes for this resource to be created.
CloudformationResource: AWS::S3Outposts::Endpoint
Link: 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 cfnEndpoint = new CfnEndpoint(this, "MyCfnEndpoint", new CfnEndpointProps {
OutpostId = "outpostId",
SecurityGroupId = "securityGroupId",
SubnetId = "subnetId",
// the properties below are optional
AccessType = "accessType",
CustomerOwnedIpv4Pool = "customerOwnedIpv4Pool"
});
Synopsis
Constructors
CfnEndpoint(Construct, String, ICfnEndpointProps) | Create a new |
CfnEndpoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AccessType | The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint. |
AttrArn | The ARN of the endpoint. |
AttrCidrBlock | The VPC CIDR block committed by this endpoint. |
AttrCreationTime | The time the endpoint was created. |
AttrId | The ID of the endpoint. |
AttrNetworkInterfaces | The network interface of the endpoint. |
AttrStatus | The status of the endpoint. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CustomerOwnedIpv4Pool | The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. |
OutpostId | The ID of the Outpost. |
SecurityGroupId | The ID of the security group to use with the endpoint. |
SubnetId | The ID of the subnet. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEndpoint(Construct, String, ICfnEndpointProps)
Create a new AWS::S3Outposts::Endpoint
.
public CfnEndpoint(Construct scope, string id, ICfnEndpointProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEndpointProps
- resource properties.
CfnEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AccessType
The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.
public virtual string AccessType { get; set; }
Property Value
System.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).
Private
is the default access type value.
AttrArn
The ARN of the endpoint.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCidrBlock
The VPC CIDR block committed by this endpoint.
public virtual string AttrCidrBlock { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CidrBlock
AttrCreationTime
The time the endpoint was created.
public virtual string AttrCreationTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreationTime
AttrId
The ID of the endpoint.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrNetworkInterfaces
The network interface of the endpoint.
public virtual IResolvable AttrNetworkInterfaces { get; }
Property Value
Remarks
CloudformationAttribute: NetworkInterfaces
AttrStatus
The status of the endpoint.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CustomerOwnedIpv4Pool
The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
public virtual string CustomerOwnedIpv4Pool { get; set; }
Property Value
System.String
Remarks
IP addresses are allocated from this pool for the endpoint.
OutpostId
The ID of the Outpost.
public virtual string OutpostId { get; set; }
Property Value
System.String
Remarks
SecurityGroupId
The ID of the security group to use with the endpoint.
public virtual string SecurityGroupId { get; set; }
Property Value
System.String
Remarks
SubnetId
The ID of the subnet.
public virtual string SubnetId { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>