Package software.amazon.awscdk.services.s3outposts

Class CfnEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.s3outposts.CfnEndpoint
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.070Z") @Stability(Stable) public class CfnEndpoint extends CfnResource implements IInspectable
A CloudFormation AWS::S3Outposts::Endpoint.

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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3outposts.*;
 CfnEndpoint cfnEndpoint = CfnEndpoint.Builder.create(this, "MyCfnEndpoint")
         .outpostId("outpostId")
         .securityGroupId("securityGroupId")
         .subnetId("subnetId")
         // the properties below are optional
         .accessType("accessType")
         .customerOwnedIpv4Pool("customerOwnedIpv4Pool")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEndpoint

      protected CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEndpoint

      protected CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEndpoint

      @Stability(Stable) public CfnEndpoint(@NotNull Construct scope, @NotNull String id, @NotNull CfnEndpointProps props)
      Create a new AWS::S3Outposts::Endpoint.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the endpoint.

    • getAttrCidrBlock

      @Stability(Stable) @NotNull public String getAttrCidrBlock()
      The VPC CIDR block committed by this endpoint.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time the endpoint was created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the endpoint.

    • getAttrNetworkInterfaces

      @Stability(Stable) @NotNull public IResolvable getAttrNetworkInterfaces()
      The network interface of the endpoint.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the endpoint.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getOutpostId

      @Stability(Stable) @NotNull public String getOutpostId()
      The ID of the Outpost.

    • setOutpostId

      @Stability(Stable) public void setOutpostId(@NotNull String value)
      The ID of the Outpost.

    • getSecurityGroupId

      @Stability(Stable) @NotNull public String getSecurityGroupId()
      The ID of the security group to use with the endpoint.

    • setSecurityGroupId

      @Stability(Stable) public void setSecurityGroupId(@NotNull String value)
      The ID of the security group to use with the endpoint.

    • getSubnetId

      @Stability(Stable) @NotNull public String getSubnetId()
      The ID of the subnet.

    • setSubnetId

      @Stability(Stable) public void setSubnetId(@NotNull String value)
      The ID of the subnet.

    • getAccessType

      @Stability(Stable) @Nullable public String getAccessType()
      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).

      Private is the default access type value.

    • setAccessType

      @Stability(Stable) public void setAccessType(@Nullable String value)
      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).

      Private is the default access type value.

    • getCustomerOwnedIpv4Pool

      @Stability(Stable) @Nullable public String getCustomerOwnedIpv4Pool()
      The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.

      IP addresses are allocated from this pool for the endpoint.

    • setCustomerOwnedIpv4Pool

      @Stability(Stable) public void setCustomerOwnedIpv4Pool(@Nullable String value)
      The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.

      IP addresses are allocated from this pool for the endpoint.