Package software.amazon.awscdk.services.pcs

Interface CfnCluster.EndpointProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.EndpointProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.EndpointProperty
extends software.amazon.jsii.JsiiSerializable

An endpoint available for interaction with the scheduler.

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.pcs.*;
 EndpointProperty endpointProperty = EndpointProperty.builder()
         .port("port")
         .privateIpAddress("privateIpAddress")
         .type("type")
         // the properties below are optional
         .ipv6Address("ipv6Address")
         .publicIpAddress("publicIpAddress")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.EndpointProperty.Builder	A builder for CfnCluster.EndpointProperty
static final class	CfnCluster.EndpointProperty.Jsii$Proxy	An implementation for CfnCluster.EndpointProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.EndpointProperty.Builder	builder()
default String	getIpv6Address()	The endpoint's IPv6 address.
String	getPort()	The endpoint's connection port number.
String	getPrivateIpAddress()	For clusters that use IPv4, this is the endpoint's private IP address.
default String	getPublicIpAddress()	The endpoint's public IP address.
String	getType()	Indicates the type of endpoint running at the specific IP address.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPort

@Stability(Stable)
@NotNull
String getPort()

The endpoint's connection port number.

Example: 1234

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-port

getPrivateIpAddress

@Stability(Stable)
@NotNull
String getPrivateIpAddress()

For clusters that use IPv4, this is the endpoint's private IP address.

Example: 10.1.2.3

For clusters configured to use IPv6, this is an empty string.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-privateipaddress

getType

@Stability(Stable)
@NotNull
String getType()

Indicates the type of endpoint running at the specific IP address.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-type

getIpv6Address

@Stability(Stable)
@Nullable
default String getIpv6Address()

The endpoint's IPv6 address.

Example: 2001:db8::1

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-ipv6address

getPublicIpAddress

@Stability(Stable)
@Nullable
default String getPublicIpAddress()

The endpoint's public IP address.

Example: 192.0.2.1

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-publicipaddress

builder

@Stability(Stable)
static CfnCluster.EndpointProperty.Builder builder()

Returns:

a CfnCluster.EndpointProperty.Builder of CfnCluster.EndpointProperty