Class CfnPipeline

The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnPipeline

Implements

IInspectable

IPipelineRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.OSIS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPipeline : CfnResource, IInspectable, IPipelineRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnPipeline Inherits CfnResource Implements IInspectable, IPipelineRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.OSIS;

             var policy;

             var cfnPipeline = new CfnPipeline(this, "MyCfnPipeline", new CfnPipelineProps {
                 MaxUnits = 123,
                 MinUnits = 123,
                 PipelineConfigurationBody = "pipelineConfigurationBody",
                 PipelineName = "pipelineName",

                 // the properties below are optional
                 BufferOptions = new BufferOptionsProperty {
                     PersistentBufferEnabled = false
                 },
                 EncryptionAtRestOptions = new EncryptionAtRestOptionsProperty {
                     KmsKeyArn = "kmsKeyArn"
                 },
                 LogPublishingOptions = new LogPublishingOptionsProperty {
                     CloudWatchLogDestination = new CloudWatchLogDestinationProperty {
                         LogGroup = "logGroup"
                     },
                     IsLoggingEnabled = false
                 },
                 PipelineRoleArn = "pipelineRoleArn",
                 ResourcePolicy = new ResourcePolicyProperty {
                     Policy = policy
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcOptions = new VpcOptionsProperty {
                     SubnetIds = new [] { "subnetIds" },

                     // the properties below are optional
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     VpcAttachmentOptions = new VpcAttachmentOptionsProperty {
                         AttachToVpc = false,
                         CidrBlock = "cidrBlock"
                     },
                     VpcEndpointManagement = "vpcEndpointManagement"
                 }
             });

Synopsis

Constructors

CfnPipeline(Construct, string, ICfnPipelineProps)

Create a new AWS::OSIS::Pipeline.

Properties

AttrIngestEndpointUrls	A list of the ingestion endpoints for the pipeline that you can send data to.
AttrPipelineArn	The Amazon Resource Name (ARN) of the pipeline.
AttrVpcEndpointService	The VPC endpoint service name for the pipeline.
AttrVpcEndpoints	The VPC interface endpoints that have access to the pipeline.
BufferOptions	Options that specify the configuration of a persistent buffer.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.
CfnPropertyNames	The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.
EncryptionAtRestOptions	Options to control how OpenSearch encrypts buffer data.
LogPublishingOptions	Key-value pairs that represent log publishing settings.
MaxUnits	The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
MinUnits	The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
PipelineConfigurationBody	The Data Prepper pipeline configuration in YAML format.
PipelineName	The name of the pipeline.
PipelineRef	A reference to a Pipeline resource.
PipelineRoleArn	The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.
ResourcePolicy	The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	List of tags to add to the pipeline upon creation.
VpcOptions	Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

Methods

ArnForPipeline(IPipelineRef)	The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnPipeline(object)	Checks whether the given object is a CfnPipeline.
RenderProperties(IDictionary<string, object>)	The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

Constructors

CfnPipeline(Construct, string, ICfnPipelineProps)

Create a new AWS::OSIS::Pipeline.

public CfnPipeline(Construct scope, string id, ICfnPipelineProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnPipelineProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

Properties

AttrIngestEndpointUrls

A list of the ingestion endpoints for the pipeline that you can send data to.

public virtual string[] AttrIngestEndpointUrls { get; }

Property Value

string[]

Remarks

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

CloudformationAttribute: IngestEndpointUrls

AttrPipelineArn

The Amazon Resource Name (ARN) of the pipeline.

public virtual string AttrPipelineArn { get; }

Property Value

string

Remarks

CloudformationAttribute: PipelineArn

AttrVpcEndpointService

The VPC endpoint service name for the pipeline.

public virtual string AttrVpcEndpointService { get; }

Property Value

string

Remarks

CloudformationAttribute: VpcEndpointService

AttrVpcEndpoints

The VPC interface endpoints that have access to the pipeline.

public virtual IResolvable AttrVpcEndpoints { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: VpcEndpoints

BufferOptions

Options that specify the configuration of a persistent buffer.

public virtual object? BufferOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPipeline.IBufferOptionsProperty

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

EncryptionAtRestOptions

Options to control how OpenSearch encrypts buffer data.

public virtual object? EncryptionAtRestOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPipeline.IEncryptionAtRestOptionsProperty

LogPublishingOptions

Key-value pairs that represent log publishing settings.

public virtual object? LogPublishingOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPipeline.ILogPublishingOptionsProperty

MaxUnits

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

public virtual double MaxUnits { get; set; }

Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

MinUnits

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

public virtual double MinUnits { get; set; }

Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

PipelineConfigurationBody

The Data Prepper pipeline configuration in YAML format.

public virtual string PipelineConfigurationBody { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

PipelineName

The name of the pipeline.

public virtual string PipelineName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

PipelineRef

A reference to a Pipeline resource.

public virtual IPipelineReference PipelineRef { get; }

Property Value

IPipelineReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

PipelineRoleArn

The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.

public virtual string? PipelineRoleArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

ResourcePolicy

The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

public virtual object? ResourcePolicy { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPipeline.IResourcePolicyProperty

TagsRaw

List of tags to add to the pipeline upon creation.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

VpcOptions

Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

public virtual object? VpcOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnPipeline.IVpcOptionsProperty

Methods

ArnForPipeline(IPipelineRef)

The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

public static string ArnForPipeline(IPipelineRef resource)

Parameters

resource IPipelineRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.OSIS;

             var policy;

             var cfnPipeline = new CfnPipeline(this, "MyCfnPipeline", new CfnPipelineProps {
                 MaxUnits = 123,
                 MinUnits = 123,
                 PipelineConfigurationBody = "pipelineConfigurationBody",
                 PipelineName = "pipelineName",

                 // the properties below are optional
                 BufferOptions = new BufferOptionsProperty {
                     PersistentBufferEnabled = false
                 },
                 EncryptionAtRestOptions = new EncryptionAtRestOptionsProperty {
                     KmsKeyArn = "kmsKeyArn"
                 },
                 LogPublishingOptions = new LogPublishingOptionsProperty {
                     CloudWatchLogDestination = new CloudWatchLogDestinationProperty {
                         LogGroup = "logGroup"
                     },
                     IsLoggingEnabled = false
                 },
                 PipelineRoleArn = "pipelineRoleArn",
                 ResourcePolicy = new ResourcePolicyProperty {
                     Policy = policy
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcOptions = new VpcOptionsProperty {
                     SubnetIds = new [] { "subnetIds" },

                     // the properties below are optional
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     VpcAttachmentOptions = new VpcAttachmentOptionsProperty {
                         AttachToVpc = false,
                         CidrBlock = "cidrBlock"
                     },
                     VpcEndpointManagement = "vpcEndpointManagement"
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

IsCfnPipeline(object)

Checks whether the given object is a CfnPipeline.

public static bool IsCfnPipeline(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

CloudformationResource: AWS::OSIS::Pipeline

ExampleMetadata: fixture=_generated

Implements

IInspectable

IPipelineRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable