Endpoint - Amazon EMR on EKS
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

Endpoint

This entity represents the endpoint that is managed by Amazon EMR on EKS.

Contents

arn

The ARN of the endpoint.

Type: String

Length Constraints: Minimum length of 60. Maximum length of 1024.

Pattern: ^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):\/virtualclusters\/[0-9a-zA-Z]+\/endpoints\/[0-9a-zA-Z]+$

Required: No

certificateArn

This member has been deprecated.

The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.

Type: String

Length Constraints: Minimum length of 44. Maximum length of 2048.

Pattern: ^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\d{12}):certificate/.+$

Required: No

certificateAuthority

The certificate generated by emr control plane on customer behalf to secure the managed endpoint.

Type: Certificate object

Required: No

configurationOverrides

The configuration settings that are used to override existing configurations for endpoints.

Type: ConfigurationOverrides object

Required: No

createdAt

The date and time when the endpoint was created.

Type: Timestamp

Required: No

executionRoleArn

The execution role ARN of the endpoint.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$

Required: No

failureReason

The reasons why the endpoint has failed.

Type: String

Valid Values: INTERNAL_ERROR | USER_ERROR | VALIDATION_ERROR | CLUSTER_UNAVAILABLE

Required: No

id

The ID of the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-z]+

Required: No

name

The name of the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_/#A-Za-z0-9]+

Required: No

releaseLabel

The EMR release version to be used for the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_/A-Za-z0-9]+

Required: No

securityGroup

The security group configuration of the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*\S.*

Required: No

serverUrl

The server URL of the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10280.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\r\n\t]*

Required: No

state

The state of the endpoint.

Type: String

Valid Values: CREATING | ACTIVE | TERMINATING | TERMINATED | TERMINATED_WITH_ERRORS

Required: No

stateDetails

Additional details of the endpoint state.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*\S.*

Required: No

subnetIds

The subnet IDs of the endpoint.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*\S.*

Required: No

tags

The tags of the endpoint.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: .*\S.*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: .*\S.*

Required: No

type

The type of the endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: .*\S.*

Required: No

virtualClusterId

The ID of the endpoint's virtual cluster.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-z]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: