Interface ICfnPipelineProps

Properties for defining a CfnPipeline.

Namespace: Amazon.CDK.AWS.OSIS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnPipelineProps

Syntax (vb)

Public Interface ICfnPipelineProps

Remarks

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

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 cfnPipelineProps = 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

Properties

BufferOptions	Options that specify the configuration of a persistent buffer.
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.
PipelineRoleArn	The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.
ResourcePolicy	Properties for defining a CfnPipeline.
Tags	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.

Properties

BufferOptions

Options that specify the configuration of a persistent buffer.

object? BufferOptions { get; }

Property Value

object

Remarks

To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .

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

Type union: either IResolvable or CfnPipeline.IBufferOptionsProperty

EncryptionAtRestOptions

Options to control how OpenSearch encrypts buffer data.

object? EncryptionAtRestOptions { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnPipeline.IEncryptionAtRestOptionsProperty

LogPublishingOptions

Key-value pairs that represent log publishing settings.

object? LogPublishingOptions { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnPipeline.ILogPublishingOptionsProperty

MaxUnits

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

double MaxUnits { get; }

Property Value

double

Remarks

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

MinUnits

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

double MinUnits { get; }

Property Value

double

Remarks

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

PipelineConfigurationBody

The Data Prepper pipeline configuration in YAML format.

string PipelineConfigurationBody { get; }

Property Value

string

Remarks

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

PipelineName

The name of the pipeline.

string PipelineName { get; }

Property Value

string

Remarks

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

PipelineRoleArn

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

string? PipelineRoleArn { get; }

Property Value

string

Remarks

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

ResourcePolicy

Properties for defining a CfnPipeline.

object? ResourcePolicy { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnPipeline.IResourcePolicyProperty

Tags

List of tags to add to the pipeline upon creation.

ICfnTag[]? Tags { get; }

Property Value

ICfnTag[]

Remarks

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

VpcOptions

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

object? VpcOptions { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnPipeline.IVpcOptionsProperty