This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::OSIS::PipelineEndpoint
Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private connectivity between your VPC and the pipeline.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::OSIS::PipelineEndpoint", "Properties" : { "PipelineArn" :String, "VpcOptions" :VpcOptions} }
YAML
Type: AWS::OSIS::PipelineEndpoint Properties: PipelineArn:StringVpcOptions:VpcOptions
Properties
PipelineArn-
The Amazon Resource Name (ARN) of the pipeline associated with this endpoint.
Required: Yes
Type: String
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):osis:.+:pipeline/.+$Minimum:
46Maximum:
76Update requires: Replacement
VpcOptions-
Configuration options for the VPC endpoint, including subnet and security group settings.
Required: Yes
Type: VpcOptions
Update requires: Replacement
Return values
Ref
Fn::GetAtt
ArnProperty description not available.
EndpointId-
The unique identifier for the pipeline endpoint.
IngestEndpointUrl-
The URL used to ingest data to the pipeline through the VPC endpoint.
Status-
The current status of the pipeline endpoint.
VpcId-
The ID of the VPC where the pipeline endpoint is created.