PipelineEndpoint
Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private connectivity between your VPC and the pipeline.
Contents
- EndpointId
-
The unique identifier for the pipeline endpoint.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 512.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-_]+$Required: No
- IngestEndpointUrl
-
The URL used to ingest data to the pipeline through the VPC endpoint.
Type: String
Required: No
- PipelineArn
-
The Amazon Resource Name (ARN) of the pipeline associated with this endpoint.
Type: String
Length Constraints: Minimum length of 46. Maximum length of 76.
Pattern:
^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$Required: No
- Status
-
The current status of the pipeline endpoint.
Type: String
Valid Values:
CREATING | ACTIVE | CREATE_FAILED | DELETING | REVOKING | REVOKEDRequired: No
- VpcId
-
The ID of the VPC where the pipeline endpoint is created.
Type: String
Required: No
- VpcOptions
-
Configuration options for the VPC endpoint, including subnet and security group settings.
Type: PipelineEndpointVpcOptions object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
