Package software.amazon.awscdk.services.osis

Class CfnPipeline

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.osis.CfnPipeline
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IPipelineRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:10.678Z") @Stability(Stable) public class CfnPipeline extends CfnResource implements IInspectable, IPipelineRef, ITaggable
The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.osis.*;
 Object policy;
 CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline")
         .maxUnits(123)
         .minUnits(123)
         .pipelineConfigurationBody("pipelineConfigurationBody")
         .pipelineName("pipelineName")
         // the properties below are optional
         .bufferOptions(BufferOptionsProperty.builder()
                 .persistentBufferEnabled(false)
                 .build())
         .encryptionAtRestOptions(EncryptionAtRestOptionsProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .build())
         .logPublishingOptions(LogPublishingOptionsProperty.builder()
                 .cloudWatchLogDestination(CloudWatchLogDestinationProperty.builder()
                         .logGroup("logGroup")
                         .build())
                 .isLoggingEnabled(false)
                 .build())
         .pipelineRoleArn("pipelineRoleArn")
         .resourcePolicy(ResourcePolicyProperty.builder()
                 .policy(policy)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcOptions(VpcOptionsProperty.builder()
                 .subnetIds(List.of("subnetIds"))
                 // the properties below are optional
                 .securityGroupIds(List.of("securityGroupIds"))
                 .vpcAttachmentOptions(VpcAttachmentOptionsProperty.builder()
                         .attachToVpc(false)
                         .cidrBlock("cidrBlock")
                         .build())
                 .vpcEndpointManagement("vpcEndpointManagement")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPipeline

      protected CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPipeline

      protected CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPipeline

      @Stability(Stable) public CfnPipeline(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPipelineProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrIngestEndpointUrls

      @Stability(Stable) @NotNull public List<String> getAttrIngestEndpointUrls()
      A list of the ingestion endpoints for the pipeline that you can send data to.

      Currently, only a single ingestion endpoint is supported for a pipeline. For example, my-pipeline-123456789012.us-east-1.osis.amazonaws.com .

    • getAttrPipelineArn

      @Stability(Stable) @NotNull public String getAttrPipelineArn()
      The Amazon Resource Name (ARN) of the pipeline.

    • getAttrVpcEndpoints

      @Stability(Stable) @NotNull public IResolvable getAttrVpcEndpoints()
      The VPC interface endpoints that have access to the pipeline.

    • getAttrVpcEndpointService

      @Stability(Stable) @NotNull public String getAttrVpcEndpointService()
      The VPC endpoint service name for the pipeline.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPipelineRef

      @Stability(Stable) @NotNull public PipelineReference getPipelineRef()
      A reference to a Pipeline resource.
      Specified by:
      getPipelineRef in interface IPipelineRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getMaxUnits

      @Stability(Stable) @NotNull public Number getMaxUnits()
      The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

    • setMaxUnits

      @Stability(Stable) public void setMaxUnits(@NotNull Number value)
      The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

    • getMinUnits

      @Stability(Stable) @NotNull public Number getMinUnits()
      The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

    • setMinUnits

      @Stability(Stable) public void setMinUnits(@NotNull Number value)
      The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

    • getPipelineConfigurationBody

      @Stability(Stable) @NotNull public String getPipelineConfigurationBody()
      The Data Prepper pipeline configuration in YAML format.

    • setPipelineConfigurationBody

      @Stability(Stable) public void setPipelineConfigurationBody(@NotNull String value)
      The Data Prepper pipeline configuration in YAML format.

    • getPipelineName

      @Stability(Stable) @NotNull public String getPipelineName()
      The name of the pipeline.

    • setPipelineName

      @Stability(Stable) public void setPipelineName(@NotNull String value)
      The name of the pipeline.

    • getBufferOptions

      @Stability(Stable) @Nullable public Object getBufferOptions()
      Options that specify the configuration of a persistent buffer.

      Returns union: either IResolvable or CfnPipeline.BufferOptionsProperty

    • setBufferOptions

      @Stability(Stable) public void setBufferOptions(@Nullable IResolvable value)
      Options that specify the configuration of a persistent buffer.

    • setBufferOptions

      @Stability(Stable) public void setBufferOptions(@Nullable CfnPipeline.BufferOptionsProperty value)
      Options that specify the configuration of a persistent buffer.

    • getEncryptionAtRestOptions

      @Stability(Stable) @Nullable public Object getEncryptionAtRestOptions()
      Options to control how OpenSearch encrypts buffer data.

      Returns union: either IResolvable or CfnPipeline.EncryptionAtRestOptionsProperty

    • setEncryptionAtRestOptions

      @Stability(Stable) public void setEncryptionAtRestOptions(@Nullable IResolvable value)
      Options to control how OpenSearch encrypts buffer data.

    • setEncryptionAtRestOptions

      @Stability(Stable) public void setEncryptionAtRestOptions(@Nullable CfnPipeline.EncryptionAtRestOptionsProperty value)
      Options to control how OpenSearch encrypts buffer data.

    • getLogPublishingOptions

      @Stability(Stable) @Nullable public Object getLogPublishingOptions()
      Key-value pairs that represent log publishing settings.

      Returns union: either IResolvable or CfnPipeline.LogPublishingOptionsProperty

    • setLogPublishingOptions

      @Stability(Stable) public void setLogPublishingOptions(@Nullable IResolvable value)
      Key-value pairs that represent log publishing settings.

    • setLogPublishingOptions

      @Stability(Stable) public void setLogPublishingOptions(@Nullable CfnPipeline.LogPublishingOptionsProperty value)
      Key-value pairs that represent log publishing settings.

    • getPipelineRoleArn

      @Stability(Stable) @Nullable public String getPipelineRoleArn()
      The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.

    • setPipelineRoleArn

      @Stability(Stable) public void setPipelineRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.

    • getResourcePolicy

      @Stability(Stable) @Nullable public Object getResourcePolicy()
      Returns union: either IResolvable or CfnPipeline.ResourcePolicyProperty

    • setResourcePolicy

      @Stability(Stable) public void setResourcePolicy(@Nullable IResolvable value)

    • setResourcePolicy

      @Stability(Stable) public void setResourcePolicy(@Nullable CfnPipeline.ResourcePolicyProperty value)

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      List of tags to add to the pipeline upon creation.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      List of tags to add to the pipeline upon creation.

    • getVpcOptions

      @Stability(Stable) @Nullable public Object getVpcOptions()
      Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

      Returns union: either IResolvable or CfnPipeline.VpcOptionsProperty

    • setVpcOptions

      @Stability(Stable) public void setVpcOptions(@Nullable IResolvable value)
      Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

    • setVpcOptions

      @Stability(Stable) public void setVpcOptions(@Nullable CfnPipeline.VpcOptionsProperty value)
      Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.