Package software.amazon.awscdk.services.osis

Class CfnPipelineBlueprint

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.CfnPipelineBlueprint
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPipelineBlueprintRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:07.787Z") @Stability(Stable) public class CfnPipelineBlueprint extends CfnResource implements IInspectable, IPipelineBlueprintRef
An OpenSearch Ingestion blueprint, which is a preconfigured template for creating an 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.*;
 CfnPipelineBlueprint cfnPipelineBlueprint = CfnPipelineBlueprint.Builder.create(this, "MyCfnPipelineBlueprint")
         .blueprintName("blueprintName")
         .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

    • CfnPipelineBlueprint

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

    • CfnPipelineBlueprint

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

    • CfnPipelineBlueprint

      @Stability(Stable) public CfnPipelineBlueprint(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnPipelineBlueprintProps props)
      Create a new AWS::OSIS::PipelineBlueprint.

      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.

    • CfnPipelineBlueprint

      @Stability(Stable) public CfnPipelineBlueprint(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::OSIS::PipelineBlueprint.

      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.

  • Method Details

    • arnForPipelineBlueprint

      @Stability(Stable) @NotNull public static String arnForPipelineBlueprint(@NotNull IPipelineBlueprintRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnPipelineBlueprint

      @Stability(Stable) @NotNull public static Boolean isCfnPipelineBlueprint(@NotNull Object x)
      Checks whether the given object is a CfnPipelineBlueprint.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrArn

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

    • getAttrDisplayDescription

      @Stability(Stable) @NotNull public String getAttrDisplayDescription()
      A description of the blueprint.

    • getAttrDisplayName

      @Stability(Stable) @NotNull public String getAttrDisplayName()
      The display name of the blueprint.

    • getAttrPipelineConfigurationBody

      @Stability(Stable) @NotNull public String getAttrPipelineConfigurationBody()
      The YAML configuration of the blueprint.

    • getAttrService

      @Stability(Stable) @NotNull public String getAttrService()
      The name of the service that the blueprint is associated with.

    • getAttrUseCase

      @Stability(Stable) @NotNull public String getAttrUseCase()
      The use case that the blueprint relates to.

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getPipelineBlueprintRef

      @Stability(Stable) @NotNull public PipelineBlueprintReference getPipelineBlueprintRef()
      A reference to a PipelineBlueprint resource.
      Specified by:
      getPipelineBlueprintRef in interface IPipelineBlueprintRef

    • getBlueprintName

      @Stability(Stable) @Nullable public String getBlueprintName()
      The name of the blueprint.

    • setBlueprintName

      @Stability(Stable) public void setBlueprintName(@Nullable String value)
      The name of the blueprint.