Interface CfnPipelineProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPipelineProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:20.188Z")
@Stability(Stable)
public interface CfnPipelineProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnPipeline
.
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.*; CfnPipelineProps cfnPipelineProps = CfnPipelineProps.builder() .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()) .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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnPipelineProps
static final class
An implementation forCfnPipelineProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnPipelineProps.Builder
builder()
default Object
Options that specify the configuration of a persistent buffer.default Object
Options to control how OpenSearch encrypts buffer data.default Object
Key-value pairs that represent log publishing settings.The maximum pipeline capacity, in Ingestion Compute Units (ICUs).The minimum pipeline capacity, in Ingestion Compute Units (ICUs).The Data Prepper pipeline configuration in YAML format.The name of the pipeline.getTags()
List of tags to add to the pipeline upon creation.default Object
Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMaxUnits
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).- See Also:
-
getMinUnits
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).- See Also:
-
getPipelineConfigurationBody
The Data Prepper pipeline configuration in YAML format.- See Also:
-
getPipelineName
The name of the pipeline.- See Also:
-
getBufferOptions
Options that specify the configuration of a persistent buffer.To configure how OpenSearch Ingestion encrypts this data, set the
EncryptionAtRestOptions
. For more information, see Persistent buffering .- See Also:
-
getEncryptionAtRestOptions
Options to control how OpenSearch encrypts buffer data.- See Also:
-
getLogPublishingOptions
Key-value pairs that represent log publishing settings.- See Also:
-
getTags
List of tags to add to the pipeline upon creation.- See Also:
-
getVpcOptions
Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.- See Also:
-
builder
- Returns:
- a
CfnPipelineProps.Builder
ofCfnPipelineProps
-