Package software.amazon.awscdk.services.s3outposts

Class CfnEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.s3outposts.CfnEndpoint
All Implemented Interfaces:
IInspectable, IEndpointRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:47.877Z") @Stability(Stable) public class CfnEndpoint extends CfnResource implements IInspectable, IEndpointRef
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")
         .failedReason(FailedReasonProperty.builder()
                 .errorCode("errorCode")
                 .message("message")
                 .build())
         .build();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnEndpointProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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

    • getEndpointRef

      @Stability(Stable) @NotNull public EndpointReference getEndpointRef()
      A reference to a Endpoint resource.
      Specified by:
      getEndpointRef in interface IEndpointRef

    • 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 used for the endpoint.

    • setSecurityGroupId

      @Stability(Stable) public void setSecurityGroupId(@NotNull String value)
      The ID of the security group used for the endpoint.

    • getSubnetId

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

    • setSubnetId

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

    • getAccessType

      @Stability(Stable) @Nullable public String getAccessType()
      The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.

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

    • getCustomerOwnedIpv4Pool

      @Stability(Stable) @Nullable public String getCustomerOwnedIpv4Pool()
      The ID of the customer-owned IPv4 address pool (CoIP 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.

    • getFailedReason

      @Stability(Stable) @Nullable public Object getFailedReason()
      The failure reason, if any, for a create or delete endpoint operation.

      Returns union: either IResolvable or CfnEndpoint.FailedReasonProperty

    • setFailedReason

      @Stability(Stable) public void setFailedReason(@Nullable IResolvable value)
      The failure reason, if any, for a create or delete endpoint operation.

    • setFailedReason

      @Stability(Stable) public void setFailedReason(@Nullable CfnEndpoint.FailedReasonProperty value)
      The failure reason, if any, for a create or delete endpoint operation.