Class: AWSCDK::OSIS::CfnPipelineProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
osis/cfn_pipeline_props.rb

Overview

Properties for defining a CfnPipeline.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(max_units:, min_units:, pipeline_configuration_body:, pipeline_name:, buffer_options: nil, encryption_at_rest_options: nil, log_publishing_options: nil, pipeline_role_arn: nil, resource_policy: nil, tags: nil, vpc_options: nil) ⇒ CfnPipelineProps

Returns a new instance of CfnPipelineProps.

Parameters:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'osis/cfn_pipeline_props.rb', line 20

def initialize(max_units:, min_units:, pipeline_configuration_body:, pipeline_name:, buffer_options: nil, encryption_at_rest_options: nil, log_publishing_options: nil, pipeline_role_arn: nil, resource_policy: nil, tags: nil, vpc_options: nil)
  @max_units = max_units
  Jsii::Type.check_type(@max_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxUnits")
  @min_units = min_units
  Jsii::Type.check_type(@min_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minUnits")
  @pipeline_configuration_body = pipeline_configuration_body
  Jsii::Type.check_type(@pipeline_configuration_body, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineConfigurationBody")
  @pipeline_name = pipeline_name
  Jsii::Type.check_type(@pipeline_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineName")
  @buffer_options = buffer_options.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::BufferOptionsProperty.new(**buffer_options.transform_keys(&:to_sym)) : buffer_options
  Jsii::Type.check_type(@buffer_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLkJ1ZmZlck9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "bufferOptions") unless @buffer_options.nil?
  @encryption_at_rest_options = encryption_at_rest_options.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::EncryptionAtRestOptionsProperty.new(**encryption_at_rest_options.transform_keys(&:to_sym)) : encryption_at_rest_options
  Jsii::Type.check_type(@encryption_at_rest_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLkVuY3J5cHRpb25BdFJlc3RPcHRpb25zUHJvcGVydHkifV19fQ==")), "encryptionAtRestOptions") unless @encryption_at_rest_options.nil?
  @log_publishing_options = log_publishing_options.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::LogPublishingOptionsProperty.new(**log_publishing_options.transform_keys(&:to_sym)) : log_publishing_options
  Jsii::Type.check_type(@log_publishing_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLkxvZ1B1Ymxpc2hpbmdPcHRpb25zUHJvcGVydHkifV19fQ==")), "logPublishingOptions") unless @log_publishing_options.nil?
  @pipeline_role_arn = pipeline_role_arn
  Jsii::Type.check_type(@pipeline_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pipelineRoleArn") unless @pipeline_role_arn.nil?
  @resource_policy = resource_policy.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::ResourcePolicyProperty.new(**resource_policy.transform_keys(&:to_sym)) : resource_policy
  Jsii::Type.check_type(@resource_policy, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLlJlc291cmNlUG9saWN5UHJvcGVydHkifV19fQ==")), "resourcePolicy") unless @resource_policy.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @vpc_options = vpc_options.is_a?(Hash) ? ::AWSCDK::OSIS::CfnPipeline::VPCOptionsProperty.new(**vpc_options.transform_keys(&:to_sym)) : vpc_options
  Jsii::Type.check_type(@vpc_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vc2lzLkNmblBpcGVsaW5lLlZwY09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "vpcOptions") unless @vpc_options.nil?
end

Instance Attribute Details

#buffer_options ⇒ AWSCDK::IResolvable, ... (readonly)

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 .

Returns:

See Also:



71
72
73
 
# File 'osis/cfn_pipeline_props.rb', line 71

def buffer_options
  @buffer_options
end

#encryption_at_rest_options ⇒ AWSCDK::IResolvable, ... (readonly)

Options to control how OpenSearch encrypts buffer data.

Returns:

See Also:



76
77
78
 
# File 'osis/cfn_pipeline_props.rb', line 76

def encryption_at_rest_options
  @encryption_at_rest_options
end

#log_publishing_options ⇒ AWSCDK::IResolvable, ... (readonly)

Key-value pairs that represent log publishing settings.

Returns:

See Also:



81
82
83
 
# File 'osis/cfn_pipeline_props.rb', line 81

def log_publishing_options
  @log_publishing_options
end

#max_units ⇒ Numeric (readonly)

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

Returns:

  • (Numeric)

See Also:



49
50
51
 
# File 'osis/cfn_pipeline_props.rb', line 49

def max_units
  @max_units
end

#min_units ⇒ Numeric (readonly)

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

Returns:

  • (Numeric)

See Also:



54
55
56
 
# File 'osis/cfn_pipeline_props.rb', line 54

def min_units
  @min_units
end

#pipeline_configuration_body ⇒ String (readonly)

The Data Prepper pipeline configuration in YAML format.

Returns:

  • (String)

See Also:



59
60
61
 
# File 'osis/cfn_pipeline_props.rb', line 59

def pipeline_configuration_body
  @pipeline_configuration_body
end

#pipeline_name ⇒ String (readonly)

The name of the pipeline.

Returns:

  • (String)

See Also:



64
65
66
 
# File 'osis/cfn_pipeline_props.rb', line 64

def pipeline_name
  @pipeline_name
end

#pipeline_role_arn ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



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

def pipeline_role_arn
  @pipeline_role_arn
end

#resource_policy ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



89
90
91
 
# File 'osis/cfn_pipeline_props.rb', line 89

def resource_policy
  @resource_policy
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

List of tags to add to the pipeline upon creation.

Returns:

See Also:



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

def tags
  @tags
end

#vpc_options ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



99
100
101
 
# File 'osis/cfn_pipeline_props.rb', line 99

def vpc_options
  @vpc_options
end

Class Method Details

.jsii_properties ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'osis/cfn_pipeline_props.rb', line 101

def self.jsii_properties
  {
    :max_units => "maxUnits",
    :min_units => "minUnits",
    :pipeline_configuration_body => "pipelineConfigurationBody",
    :pipeline_name => "pipelineName",
    :buffer_options => "bufferOptions",
    :encryption_at_rest_options => "encryptionAtRestOptions",
    :log_publishing_options => "logPublishingOptions",
    :pipeline_role_arn => "pipelineRoleArn",
    :resource_policy => "resourcePolicy",
    :tags => "tags",
    :vpc_options => "vpcOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'osis/cfn_pipeline_props.rb', line 117

def to_jsii
  result = {}
  result.merge!({
    "maxUnits" => @max_units,
    "minUnits" => @min_units,
    "pipelineConfigurationBody" => @pipeline_configuration_body,
    "pipelineName" => @pipeline_name,
    "bufferOptions" => @buffer_options,
    "encryptionAtRestOptions" => @encryption_at_rest_options,
    "logPublishingOptions" => @log_publishing_options,
    "pipelineRoleArn" => @pipeline_role_arn,
    "resourcePolicy" => @resource_policy,
    "tags" => @tags,
    "vpcOptions" => @vpc_options,
  })
  result.compact
end