VpcEndpoint - Amazon OpenSearch Service

VpcEndpoint

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

Contents

DomainArn

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

Type: String

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

Pattern: arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+

Required: No

Endpoint

The connection endpoint ID for connecting to the domain.

Type: String

Pattern: ^[A-Za-z0-9\-\.]+$

Required: No

Status

The current status of the endpoint.

Type: String

Valid Values: CREATING | CREATE_FAILED | ACTIVE | UPDATING | UPDATE_FAILED | DELETING | DELETE_FAILED

Required: No

VpcEndpointId

The unique identifier of the endpoint.

Type: String

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

Pattern: ^aos-[a-zA-Z0-9]*$

Required: No

VpcEndpointOwner

The creator of the endpoint.

Type: String

Pattern: ^[0-9]+$

Required: No

VpcOptions

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

Type: VPCDerivedInfo object

Required: No

See Also

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