Interface CfnEndpointProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEndpointProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-09-11T18:01:23.101Z")
@Stability(Stable)
public interface CfnEndpointProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnEndpoint
.
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.*; CfnEndpointProps cfnEndpointProps = CfnEndpointProps.builder() .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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnEndpointProps
static final class
An implementation forCfnEndpointProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnEndpointProps.Builder
builder()
default String
The container for the type of connectivity used to access the Amazon S3 on Outposts endpoint.default String
The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.default Object
The failure reason, if any, for a create or delete endpoint operation.The ID of the Outpost.The ID of the security group used for the endpoint.The ID of the subnet used for the endpoint.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getOutpostId
The ID of the Outpost.- See Also:
-
getSecurityGroupId
The ID of the security group used for the endpoint.- See Also:
-
getSubnetId
The ID of the subnet used for the endpoint.- See Also:
-
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, chooseCustomerOwnedIp
. If you chooseCustomerOwnedIp
, you must also provide the customer-owned IP address pool (CoIP pool).Private
is the default access type value.Default: - "Private"
- See Also:
-
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.
- See Also:
-
getFailedReason
The failure reason, if any, for a create or delete endpoint operation.- See Also:
-
builder
- Returns:
- a
CfnEndpointProps.Builder
ofCfnEndpointProps
-