CfnPipeline
- class aws_cdk.aws_osis.CfnPipeline(scope, id, *, max_units, min_units, pipeline_configuration_body, pipeline_name, buffer_options=None, encryption_at_rest_options=None, log_publishing_options=None, tags=None, vpc_options=None)
Bases:
CfnResource
The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html
- CloudformationResource:
AWS::OSIS::Pipeline
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_osis as osis cfn_pipeline = osis.CfnPipeline(self, "MyCfnPipeline", max_units=123, min_units=123, pipeline_configuration_body="pipelineConfigurationBody", pipeline_name="pipelineName", # the properties below are optional buffer_options=osis.CfnPipeline.BufferOptionsProperty( persistent_buffer_enabled=False ), encryption_at_rest_options=osis.CfnPipeline.EncryptionAtRestOptionsProperty( kms_key_arn="kmsKeyArn" ), log_publishing_options=osis.CfnPipeline.LogPublishingOptionsProperty( cloud_watch_log_destination=osis.CfnPipeline.CloudWatchLogDestinationProperty( log_group="logGroup" ), is_logging_enabled=False ), tags=[CfnTag( key="key", value="value" )], vpc_options=osis.CfnPipeline.VpcOptionsProperty( subnet_ids=["subnetIds"], # the properties below are optional security_group_ids=["securityGroupIds"], vpc_attachment_options=osis.CfnPipeline.VpcAttachmentOptionsProperty( attach_to_vpc=False, cidr_block="cidrBlock" ), vpc_endpoint_management="vpcEndpointManagement" ) )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).max_units (
Union
[int
,float
]) – The maximum pipeline capacity, in Ingestion Compute Units (ICUs).min_units (
Union
[int
,float
]) – The minimum pipeline capacity, in Ingestion Compute Units (ICUs).pipeline_configuration_body (
str
) – The Data Prepper pipeline configuration in YAML format.pipeline_name (
str
) – The name of the pipeline.buffer_options (
Union
[IResolvable
,BufferOptionsProperty
,Dict
[str
,Any
],None
]) – Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set theEncryptionAtRestOptions
. For more information, see Persistent buffering .encryption_at_rest_options (
Union
[IResolvable
,EncryptionAtRestOptionsProperty
,Dict
[str
,Any
],None
]) – Options to control how OpenSearch encrypts buffer data.log_publishing_options (
Union
[IResolvable
,LogPublishingOptionsProperty
,Dict
[str
,Any
],None
]) – Key-value pairs that represent log publishing settings.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – List of tags to add to the pipeline upon creation.vpc_options (
Union
[IResolvable
,VpcOptionsProperty
,Dict
[str
,Any
],None
]) – Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::OSIS::Pipeline'
- attr_ingest_endpoint_urls
A list of the ingestion endpoints for the pipeline that you can send data to.
Currently, only a single ingestion endpoint is supported for a pipeline. For example,
my-pipeline-123456789012.us-east-1.osis.amazonaws.com
.- CloudformationAttribute:
IngestEndpointUrls
- attr_pipeline_arn
The Amazon Resource Name (ARN) of the pipeline.
- CloudformationAttribute:
PipelineArn
- attr_vpc_endpoint_service
The VPC endpoint service name for the pipeline.
- CloudformationAttribute:
VpcEndpointService
- attr_vpc_endpoints
The VPC interface endpoints that have access to the pipeline.
- CloudformationAttribute:
VpcEndpoints
- buffer_options
Options that specify the configuration of a persistent buffer.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- encryption_at_rest_options
Options to control how OpenSearch encrypts buffer data.
- log_publishing_options
Key-value pairs that represent log publishing settings.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- max_units
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
- min_units
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
- node
The tree node.
- pipeline_configuration_body
The Data Prepper pipeline configuration in YAML format.
- pipeline_name
The name of the pipeline.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
List of tags to add to the pipeline upon creation.
- vpc_options
Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
BufferOptionsProperty
- class CfnPipeline.BufferOptionsProperty(*, persistent_buffer_enabled)
Bases:
object
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 .- Parameters:
persistent_buffer_enabled (
Union
[bool
,IResolvable
]) – Whether persistent buffering should be enabled.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_osis as osis buffer_options_property = osis.CfnPipeline.BufferOptionsProperty( persistent_buffer_enabled=False )
Attributes
- persistent_buffer_enabled
Whether persistent buffering should be enabled.
CloudWatchLogDestinationProperty
- class CfnPipeline.CloudWatchLogDestinationProperty(*, log_group)
Bases:
object
The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.
- Parameters:
log_group (
str
) – The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example,/aws/vendedlogs/OpenSearchService/pipelines
.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_osis as osis cloud_watch_log_destination_property = osis.CfnPipeline.CloudWatchLogDestinationProperty( log_group="logGroup" )
Attributes
- log_group
The name of the CloudWatch Logs group to send pipeline logs to.
You can specify an existing log group or create a new one. For example,
/aws/vendedlogs/OpenSearchService/pipelines
.
EncryptionAtRestOptionsProperty
- class CfnPipeline.EncryptionAtRestOptionsProperty(*, kms_key_arn)
Bases:
object
Options to control how OpenSearch encrypts buffer data.
- Parameters:
kms_key_arn (
str
) – The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an AWS owned key.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_osis as osis encryption_at_rest_options_property = osis.CfnPipeline.EncryptionAtRestOptionsProperty( kms_key_arn="kmsKeyArn" )
Attributes
- kms_key_arn
The ARN of the KMS key used to encrypt buffer data.
By default, data is encrypted using an AWS owned key.
LogPublishingOptionsProperty
- class CfnPipeline.LogPublishingOptionsProperty(*, cloud_watch_log_destination=None, is_logging_enabled=None)
Bases:
object
Container for the values required to configure logging for the pipeline.
If you don’t specify these values, OpenSearch Ingestion will not publish logs from your application to CloudWatch Logs.
- Parameters:
cloud_watch_log_destination (
Union
[IResolvable
,CloudWatchLogDestinationProperty
,Dict
[str
,Any
],None
]) – The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required ifIsLoggingEnabled
is set totrue
.is_logging_enabled (
Union
[bool
,IResolvable
,None
]) – Whether logs should be published.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_osis as osis log_publishing_options_property = osis.CfnPipeline.LogPublishingOptionsProperty( cloud_watch_log_destination=osis.CfnPipeline.CloudWatchLogDestinationProperty( log_group="logGroup" ), is_logging_enabled=False )
Attributes
- cloud_watch_log_destination
The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs.
This parameter is required if
IsLoggingEnabled
is set totrue
.
- is_logging_enabled
Whether logs should be published.
VpcAttachmentOptionsProperty
- class CfnPipeline.VpcAttachmentOptionsProperty(*, attach_to_vpc, cidr_block)
Bases:
object
Options for attaching a VPC to pipeline.
- Parameters:
attach_to_vpc (
Union
[bool
,IResolvable
]) – Whether a VPC is attached to the pipeline.cidr_block (
str
) – The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_osis as osis vpc_attachment_options_property = osis.CfnPipeline.VpcAttachmentOptionsProperty( attach_to_vpc=False, cidr_block="cidrBlock" )
Attributes
- attach_to_vpc
Whether a VPC is attached to the pipeline.
- cidr_block
The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
VpcEndpointProperty
- class CfnPipeline.VpcEndpointProperty(*, vpc_endpoint_id=None, vpc_id=None, vpc_options=None)
Bases:
object
An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.
- Parameters:
vpc_endpoint_id (
Optional
[str
]) – The unique identifier of the endpoint.vpc_id (
Optional
[str
]) – The ID for your VPC. AWS PrivateLink generates this value when you create a VPC.vpc_options (
Union
[IResolvable
,VpcOptionsProperty
,Dict
[str
,Any
],None
]) – Information about the VPC, including associated subnets and security groups.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_osis as osis vpc_endpoint_property = osis.CfnPipeline.VpcEndpointProperty( vpc_endpoint_id="vpcEndpointId", vpc_id="vpcId", vpc_options=osis.CfnPipeline.VpcOptionsProperty( subnet_ids=["subnetIds"], # the properties below are optional security_group_ids=["securityGroupIds"], vpc_attachment_options=osis.CfnPipeline.VpcAttachmentOptionsProperty( attach_to_vpc=False, cidr_block="cidrBlock" ), vpc_endpoint_management="vpcEndpointManagement" ) )
Attributes
- vpc_endpoint_id
The unique identifier of the endpoint.
- vpc_id
The ID for your VPC.
AWS PrivateLink generates this value when you create a VPC.
- vpc_options
Information about the VPC, including associated subnets and security groups.
VpcOptionsProperty
- class CfnPipeline.VpcOptionsProperty(*, subnet_ids, security_group_ids=None, vpc_attachment_options=None, vpc_endpoint_management=None)
Bases:
object
Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
- Parameters:
subnet_ids (
Sequence
[str
]) – A list of subnet IDs associated with the VPC endpoint.security_group_ids (
Optional
[Sequence
[str
]]) – A list of security groups associated with the VPC endpoint.vpc_attachment_options (
Union
[IResolvable
,VpcAttachmentOptionsProperty
,Dict
[str
,Any
],None
]) – Options for attaching a VPC to a pipeline.vpc_endpoint_management (
Optional
[str
]) – Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_osis as osis vpc_options_property = osis.CfnPipeline.VpcOptionsProperty( subnet_ids=["subnetIds"], # the properties below are optional security_group_ids=["securityGroupIds"], vpc_attachment_options=osis.CfnPipeline.VpcAttachmentOptionsProperty( attach_to_vpc=False, cidr_block="cidrBlock" ), vpc_endpoint_management="vpcEndpointManagement" )
Attributes
- security_group_ids
A list of security groups associated with the VPC endpoint.
- subnet_ids
A list of subnet IDs associated with the VPC endpoint.
- vpc_attachment_options
Options for attaching a VPC to a pipeline.
- vpc_endpoint_management
Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.