interface EndpointProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.PCS.CfnClusterPropsMixin.EndpointProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awspcs#CfnClusterPropsMixin_EndpointProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.pcs.CfnClusterPropsMixin.EndpointProperty
Python	aws_cdk.cfn_property_mixins.aws_pcs.CfnClusterPropsMixin.EndpointProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_pcs » CfnClusterPropsMixin » EndpointProperty

An endpoint available for interaction with the scheduler.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pcs as pcs } from '@aws-cdk/cfn-property-mixins';
const endpointProperty: pcs.CfnClusterPropsMixin.EndpointProperty = {
  ipv6Address: 'ipv6Address',
  port: 'port',
  privateIpAddress: 'privateIpAddress',
  publicIpAddress: 'publicIpAddress',
  type: 'type',
};

Properties

Name	Type	Description
ipv6Address?	string	The endpoint's IPv6 address.
port?	string	The endpoint's connection port number.
privateIpAddress?	string	For clusters that use IPv4, this is the endpoint's private IP address.
publicIpAddress?	string	The endpoint's public IP address.
type?	string	Indicates the type of endpoint running at the specific IP address.

---

ipv6Address?

Type: string (optional)

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

---

port?

Type: string (optional)

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

---

privateIpAddress?

Type: string (optional)

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

---

publicIpAddress?

Type: string (optional)

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

---

type?

Type: string (optional)

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