Class: AWSCDK::OSIS::CfnPipeline

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSOsis::IPipelineRef
Defined in:
osis/cfn_pipeline.rb

Overview

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPipeline

Create a new AWS::OSIS::Pipeline.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::OSIS::CfnPipelineProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'osis/cfn_pipeline.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipelineProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3Npcy5DZm5QaXBlbGluZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_pipeline(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'osis/cfn_pipeline.rb', line 85

def self.arn_for_pipeline(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19vc2lzLklQaXBlbGluZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_osis.CfnPipeline", "arnForPipeline", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


192
193
194
 
# File 'osis/cfn_pipeline.rb', line 192

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_osis.CfnPipeline", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_pipeline(x) ⇒ Boolean

Checks whether the given object is a CfnPipeline.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'osis/cfn_pipeline.rb', line 94

def self.is_cfn_pipeline(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_osis.CfnPipeline", "isCfnPipeline", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'osis/cfn_pipeline.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_ingest_endpoint_urls => { kind: :property, name: "attrIngestEndpointUrls", is_optional: false },
    :attr_pipeline_arn => { kind: :property, name: "attrPipelineArn", is_optional: false },
    :attr_vpc_endpoints => { kind: :property, name: "attrVpcEndpoints", is_optional: false },
    :attr_vpc_endpoint_service => { kind: :property, name: "attrVpcEndpointService", is_optional: false },
    :pipeline_ref => { kind: :property, name: "pipelineRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :max_units => { kind: :property, name: "maxUnits", is_optional: false },
    :min_units => { kind: :property, name: "minUnits", is_optional: false },
    :pipeline_configuration_body => { kind: :property, name: "pipelineConfigurationBody", is_optional: false },
    :pipeline_name => { kind: :property, name: "pipelineName", is_optional: false },
    :buffer_options => { kind: :property, name: "bufferOptions", is_optional: true },
    :encryption_at_rest_options => { kind: :property, name: "encryptionAtRestOptions", is_optional: true },
    :log_publishing_options => { kind: :property, name: "logPublishingOptions", is_optional: true },
    :pipeline_role_arn => { kind: :property, name: "pipelineRoleArn", is_optional: true },
    :resource_policy => { kind: :property, name: "resourcePolicy", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :vpc_options => { kind: :property, name: "vpcOptions", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



412
413
414
415
 
# File 'osis/cfn_pipeline.rb', line 412

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



424
425
426
427
 
# File 'osis/cfn_pipeline.rb', line 424

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



434
435
436
437
 
# File 'osis/cfn_pipeline.rb', line 434

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



445
446
447
448
449
 
# File 'osis/cfn_pipeline.rb', line 445

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path 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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


502
503
504
505
506
 
# File 'osis/cfn_pipeline.rb', line 502

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



512
513
514
515
 
# File 'osis/cfn_pipeline.rb', line 512

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



524
525
526
527
528
 
# File 'osis/cfn_pipeline.rb', line 524

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



537
538
539
540
 
# File 'osis/cfn_pipeline.rb', line 537

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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:

See Also:



559
560
561
562
563
564
 
# File 'osis/cfn_pipeline.rb', line 559

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_ingest_endpoint_urls ⇒ Array<String>

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 .

Returns:

  • (Array<String>) 


201
202
203
 
# File 'osis/cfn_pipeline.rb', line 201

def attr_ingest_endpoint_urls()
  jsii_get_property("attrIngestEndpointUrls")
end

#attr_pipeline_arn ⇒ String

The Amazon Resource Name (ARN) of the pipeline.

Returns:

  • (String) 


208
209
210
 
# File 'osis/cfn_pipeline.rb', line 208

def attr_pipeline_arn()
  jsii_get_property("attrPipelineArn")
end

#attr_vpc_endpoint_service ⇒ String

The VPC endpoint service name for the pipeline.

Returns:

  • (String) 


222
223
224
 
# File 'osis/cfn_pipeline.rb', line 222

def attr_vpc_endpoint_service()
  jsii_get_property("attrVpcEndpointService")
end

#attr_vpc_endpoints ⇒ AWSCDK::IResolvable

The VPC interface endpoints that have access to the pipeline.

Returns:



215
216
217
 
# File 'osis/cfn_pipeline.rb', line 215

def attr_vpc_endpoints()
  jsii_get_property("attrVpcEndpoints")
end

#buffer_options ⇒ AWSCDK::IResolvable, ...

Options that specify the configuration of a persistent buffer.

Returns:



291
292
293
 
# File 'osis/cfn_pipeline.rb', line 291

def buffer_options()
  jsii_get_property("bufferOptions")
end

#buffer_options=(value) ⇒ Object 



295
296
297
298
299
 
# File 'osis/cfn_pipeline.rb', line 295

def buffer_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::BufferOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLkJ1ZmZlck9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "bufferOptions") unless value.nil?
  jsii_set_property("bufferOptions", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



145
146
147
 
# File 'osis/cfn_pipeline.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 'osis/cfn_pipeline.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


568
569
570
571
 
# File 'osis/cfn_pipeline.rb', line 568

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


155
156
157
 
# File 'osis/cfn_pipeline.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 'osis/cfn_pipeline.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


107
108
109
 
# File 'osis/cfn_pipeline.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#encryption_at_rest_options ⇒ AWSCDK::IResolvable, ...

Options to control how OpenSearch encrypts buffer data.

Returns:



304
305
306
 
# File 'osis/cfn_pipeline.rb', line 304

def encryption_at_rest_options()
  jsii_get_property("encryptionAtRestOptions")
end

#encryption_at_rest_options=(value) ⇒ Object 



308
309
310
311
312
 
# File 'osis/cfn_pipeline.rb', line 308

def encryption_at_rest_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::EncryptionAtRestOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLkVuY3J5cHRpb25BdFJlc3RPcHRpb25zUHJvcGVydHkifV19fQ==")), "encryptionAtRestOptions") unless value.nil?
  jsii_set_property("encryptionAtRestOptions", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



167
168
169
 
# File 'osis/cfn_pipeline.rb', line 167

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



581
582
583
584
585
 
# File 'osis/cfn_pipeline.rb', line 581

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



592
593
594
595
 
# File 'osis/cfn_pipeline.rb', line 592

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



662
663
664
665
 
# File 'osis/cfn_pipeline.rb', line 662

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#log_publishing_options ⇒ AWSCDK::IResolvable, ...

Key-value pairs that represent log publishing settings.

Returns:



317
318
319
 
# File 'osis/cfn_pipeline.rb', line 317

def log_publishing_options()
  jsii_get_property("logPublishingOptions")
end

#log_publishing_options=(value) ⇒ Object 



321
322
323
324
325
 
# File 'osis/cfn_pipeline.rb', line 321

def log_publishing_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::LogPublishingOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLkxvZ1B1Ymxpc2hpbmdPcHRpb25zUHJvcGVydHkifV19fQ==")), "logPublishingOptions") unless value.nil?
  jsii_set_property("logPublishingOptions", value)
end

#logical_id ⇒ String

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 override_logical_id(new_logical_id).

Returns:

  • (String) 


119
120
121
 
# File 'osis/cfn_pipeline.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#max_units ⇒ Numeric

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

Returns:

  • (Numeric) 


243
244
245
 
# File 'osis/cfn_pipeline.rb', line 243

def max_units()
  jsii_get_property("maxUnits")
end

#max_units=(value) ⇒ Object 



247
248
249
250
 
# File 'osis/cfn_pipeline.rb', line 247

def max_units=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxUnits")
  jsii_set_property("maxUnits", value)
end

#min_units ⇒ Numeric

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

Returns:

  • (Numeric) 


255
256
257
 
# File 'osis/cfn_pipeline.rb', line 255

def min_units()
  jsii_get_property("minUnits")
end

#min_units=(value) ⇒ Object 



259
260
261
262
 
# File 'osis/cfn_pipeline.rb', line 259

def min_units=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minUnits")
  jsii_set_property("minUnits", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


102
103
104
 
# File 'osis/cfn_pipeline.rb', line 102

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



603
604
605
 
# File 'osis/cfn_pipeline.rb', line 603

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



610
611
612
 
# File 'osis/cfn_pipeline.rb', line 610

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



403
404
405
406
 
# File 'osis/cfn_pipeline.rb', line 403

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#pipeline_configuration_body ⇒ String

The Data Prepper pipeline configuration in YAML format.

Returns:

  • (String) 


267
268
269
 
# File 'osis/cfn_pipeline.rb', line 267

def pipeline_configuration_body()
  jsii_get_property("pipelineConfigurationBody")
end

#pipeline_configuration_body=(value) ⇒ Object 



271
272
273
274
 
# File 'osis/cfn_pipeline.rb', line 271

def pipeline_configuration_body=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineConfigurationBody")
  jsii_set_property("pipelineConfigurationBody", value)
end

#pipeline_name ⇒ String

The name of the pipeline.

Returns:

  • (String) 


279
280
281
 
# File 'osis/cfn_pipeline.rb', line 279

def pipeline_name()
  jsii_get_property("pipelineName")
end

#pipeline_name=(value) ⇒ Object 



283
284
285
286
 
# File 'osis/cfn_pipeline.rb', line 283

def pipeline_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineName")
  jsii_set_property("pipelineName", value)
end

#pipeline_ref ⇒ AWSCDK::Interfaces::AWSOsis::PipelineReference

A reference to a Pipeline resource.

Returns:



229
230
231
 
# File 'osis/cfn_pipeline.rb', line 229

def pipeline_ref()
  jsii_get_property("pipelineRef")
end

#pipeline_role_arn ⇒ String?

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

Returns:

  • (String, nil) 


330
331
332
 
# File 'osis/cfn_pipeline.rb', line 330

def pipeline_role_arn()
  jsii_get_property("pipelineRoleArn")
end

#pipeline_role_arn=(value) ⇒ Object 



334
335
336
337
 
# File 'osis/cfn_pipeline.rb', line 334

def pipeline_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineRoleArn") unless value.nil?
  jsii_set_property("pipelineRoleArn", value)
end

#ref ⇒ String

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 }).

Returns:

  • (String) 


138
139
140
 
# File 'osis/cfn_pipeline.rb', line 138

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

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:



621
622
623
624
 
# File 'osis/cfn_pipeline.rb', line 621

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


628
629
630
631
 
# File 'osis/cfn_pipeline.rb', line 628

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



638
639
640
641
642
 
# File 'osis/cfn_pipeline.rb', line 638

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#resource_policy ⇒ AWSCDK::IResolvable, ...

Returns:



340
341
342
 
# File 'osis/cfn_pipeline.rb', line 340

def resource_policy()
  jsii_get_property("resourcePolicy")
end

#resource_policy=(value) ⇒ Object 



344
345
346
347
348
 
# File 'osis/cfn_pipeline.rb', line 344

def resource_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::ResourcePolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLlJlc291cmNlUG9saWN5UHJvcGVydHkifV19fQ==")), "resourcePolicy") unless value.nil?
  jsii_set_property("resourcePolicy", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



647
648
649
 
# File 'osis/cfn_pipeline.rb', line 647

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



128
129
130
 
# File 'osis/cfn_pipeline.rb', line 128

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



236
237
238
 
# File 'osis/cfn_pipeline.rb', line 236

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

List of tags to add to the pipeline upon creation.

Returns:



353
354
355
 
# File 'osis/cfn_pipeline.rb', line 353

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



357
358
359
360
361
 
# File 'osis/cfn_pipeline.rb', line 357

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



379
380
381
 
# File 'osis/cfn_pipeline.rb', line 379

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


175
176
177
 
# File 'osis/cfn_pipeline.rb', line 175

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


185
186
187
 
# File 'osis/cfn_pipeline.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


653
654
655
656
 
# File 'osis/cfn_pipeline.rb', line 653

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_options ⇒ AWSCDK::IResolvable, ...

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

Returns:



366
367
368
 
# File 'osis/cfn_pipeline.rb', line 366

def vpc_options()
  jsii_get_property("vpcOptions")
end

#vpc_options=(value) ⇒ Object 



370
371
372
373
374
 
# File 'osis/cfn_pipeline.rb', line 370

def vpc_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::VPCOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLlZwY09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "vpcOptions") unless value.nil?
  jsii_set_property("vpcOptions", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


392
393
394
395
396
397
 
# File 'osis/cfn_pipeline.rb', line 392

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end