Class CfnPipeline
A CloudFormation AWS::OSIS::Pipeline
.
Inherited Members
Namespace: Amazon.CDK.AWS.OSIS
Assembly: Amazon.CDK.AWS.OSIS.dll
Syntax (csharp)
public class CfnPipeline : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnPipeline
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.
CloudformationResource: AWS::OSIS::Pipeline
Link: 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 cfnPipeline = new CfnPipeline(this, "MyCfnPipeline", new CfnPipelineProps {
MaxUnits = 123,
MinUnits = 123,
PipelineConfigurationBody = "pipelineConfigurationBody",
PipelineName = "pipelineName",
// the properties below are optional
LogPublishingOptions = new LogPublishingOptionsProperty {
CloudWatchLogDestination = new CloudWatchLogDestinationProperty {
LogGroup = "logGroup"
},
IsLoggingEnabled = false
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VpcOptions = new VpcOptionsProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
});
Synopsis
Constructors
CfnPipeline(Construct, String, ICfnPipelineProps) | Create a new |
CfnPipeline(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPipeline(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrIngestEndpointUrls | The ingestion endpoints for the pipeline that you can send data to. |
AttrPipelineArn | The Amazon Resource Name (ARN) of the pipeline. |
AttrVpcEndpoints | The VPC interface endpoints that have access to the pipeline. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnPipelineProps
- resource properties.
CfnPipeline(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPipeline(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPipeline(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPipeline(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrIngestEndpointUrls
The ingestion endpoints for the pipeline that you can send data to.
public virtual string[] AttrIngestEndpointUrls { get; }
Property Value
System.String[]
Remarks
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
System.String
Remarks
CloudformationAttribute: PipelineArn
AttrVpcEndpoints
The VPC interface endpoints that have access to the pipeline.
public virtual IResolvable AttrVpcEndpoints { get; }
Property Value
Remarks
CloudformationAttribute: VpcEndpoints
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
LogPublishingOptions
Key-value pairs that represent log publishing settings.
public virtual object LogPublishingOptions { get; set; }
Property Value
System.Object
Remarks
MaxUnits
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
public virtual double MaxUnits { get; set; }
Property Value
System.Double
Remarks
MinUnits
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
public virtual double MinUnits { get; set; }
Property Value
System.Double
Remarks
PipelineConfigurationBody
The Data Prepper pipeline configuration in YAML format.
public virtual string PipelineConfigurationBody { get; set; }
Property Value
System.String
Remarks
PipelineName
The name of the pipeline.
public virtual string PipelineName { get; set; }
Property Value
System.String
Remarks
Tags
List of tags to add to the pipeline upon creation.
public virtual TagManager Tags { get; }
Property Value
Remarks
VpcOptions
Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
public virtual object VpcOptions { get; set; }
Property Value
System.Object
Remarks
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>