Class: AWSCDK::Pipes::CfnPipeProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pipes/cfn_pipe_props.rb

Overview

Properties for defining a CfnPipe.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(role_arn:, source:, target:, description: nil, desired_state: nil, enrichment: nil, enrichment_parameters: nil, kms_key_identifier: nil, log_configuration: nil, name: nil, source_parameters: nil, tags: nil, target_parameters: nil) ⇒ CfnPipeProps

Returns a new instance of CfnPipeProps.

Parameters:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'pipes/cfn_pipe_props.rb', line 22

def initialize(role_arn:, source:, target:, description: nil, desired_state: nil, enrichment: nil, enrichment_parameters: nil, kms_key_identifier: nil, log_configuration: nil, name: nil, source_parameters: nil, tags: nil, target_parameters: nil)
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifV19fQ==")), "roleArn")
  @source = source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19raW5lc2lzLklTdHJlYW1SZWYifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX3Nxcy5JUXVldWVSZWYifV19fQ==")), "source")
  @target = target
  Jsii::Type.check_type(@target, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19ldmVudHMuSUV2ZW50QnVzUmVmIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sYW1iZGEuSUZ1bmN0aW9uUmVmIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sb2dzLklMb2dHcm91cFJlZiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuaW50ZXJmYWNlcy5hd3Nfc25zLklUb3BpY1JlZiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuaW50ZXJmYWNlcy5hd3Nfc3FzLklRdWV1ZVJlZiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuaW50ZXJmYWNlcy5hd3Nfc3RlcGZ1bmN0aW9ucy5JU3RhdGVNYWNoaW5lUmVmIn1dfX0=")), "target")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @desired_state = desired_state
  Jsii::Type.check_type(@desired_state, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "desiredState") unless @desired_state.nil?
  @enrichment = enrichment
  Jsii::Type.check_type(@enrichment, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19sYW1iZGEuSUZ1bmN0aW9uUmVmIn1dfX0=")), "enrichment") unless @enrichment.nil?
  @enrichment_parameters = enrichment_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeEnrichmentParametersProperty.new(**enrichment_parameters.transform_keys(&:to_sym)) : enrichment_parameters
  Jsii::Type.check_type(@enrichment_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVFbnJpY2htZW50UGFyYW1ldGVyc1Byb3BlcnR5In1dfX0=")), "enrichmentParameters") unless @enrichment_parameters.nil?
  @kms_key_identifier = kms_key_identifier
  Jsii::Type.check_type(@kms_key_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyIdentifier") unless @kms_key_identifier.nil?
  @log_configuration = log_configuration.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeLogConfigurationProperty.new(**log_configuration.transform_keys(&:to_sym)) : log_configuration
  Jsii::Type.check_type(@log_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVMb2dDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "logConfiguration") unless @log_configuration.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @source_parameters = source_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeSourceParametersProperty.new(**source_parameters.transform_keys(&:to_sym)) : source_parameters
  Jsii::Type.check_type(@source_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVTb3VyY2VQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "sourceParameters") unless @source_parameters.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @target_parameters = target_parameters.is_a?(Hash) ? ::AWSCDK::Pipes::CfnPipe::PipeTargetParametersProperty.new(**target_parameters.transform_keys(&:to_sym)) : target_parameters
  Jsii::Type.check_type(@target_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waXBlcy5DZm5QaXBlLlBpcGVUYXJnZXRQYXJhbWV0ZXJzUHJvcGVydHkifV19fQ==")), "targetParameters") unless @target_parameters.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

A description of the pipe.

Returns:

  • (String, nil)

See Also:



70
71
72
 
# File 'pipes/cfn_pipe_props.rb', line 70

def description
  @description
end

#desired_state ⇒ String? (readonly)

The state the pipe should be in.

Returns:

  • (String, nil)

See Also:



75
76
77
 
# File 'pipes/cfn_pipe_props.rb', line 75

def desired_state
  @desired_state
end

#enrichment ⇒ String, ... (readonly)

The ARN of the enrichment resource.

Returns:

See Also:



80
81
82
 
# File 'pipes/cfn_pipe_props.rb', line 80

def enrichment
  @enrichment
end

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

The parameters required to set up enrichment on your pipe.

Returns:

See Also:



85
86
87
 
# File 'pipes/cfn_pipe_props.rb', line 85

def enrichment_parameters
  @enrichment_parameters
end

#kms_key_identifier ⇒ String? (readonly)

The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.

The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.

To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string.

For more information, see Managing keys in the AWS Key Management Service Developer Guide .

Returns:

  • (String, nil)

See Also:



98
99
100
 
# File 'pipes/cfn_pipe_props.rb', line 98

def kms_key_identifier
  @kms_key_identifier
end

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

The logging configuration settings for the pipe.

Returns:

See Also:



103
104
105
 
# File 'pipes/cfn_pipe_props.rb', line 103

def log_configuration
  @log_configuration
end

#name ⇒ String? (readonly)

The name of the pipe.

Returns:

  • (String, nil)

See Also:



108
109
110
 
# File 'pipes/cfn_pipe_props.rb', line 108

def name
  @name
end

#role_arn ⇒ String, AWSCDK::Interfaces::AWSIAM::IRoleRef (readonly)

The ARN of the role that allows the pipe to send data to the target.

Returns:

See Also:



55
56
57
 
# File 'pipes/cfn_pipe_props.rb', line 55

def role_arn
  @role_arn
end

#source ⇒ String, ... (readonly)

The ARN of the source resource.

Returns:

See Also:



60
61
62
 
# File 'pipes/cfn_pipe_props.rb', line 60

def source
  @source
end

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

The parameters required to set up a source for your pipe.

Returns:

See Also:



113
114
115
 
# File 'pipes/cfn_pipe_props.rb', line 113

def source_parameters
  @source_parameters
end

#tags ⇒ Hash{String => String}? (readonly)

The list of key-value pairs to associate with the pipe.

Returns:

  • (Hash{String => String}, nil)

See Also:



118
119
120
 
# File 'pipes/cfn_pipe_props.rb', line 118

def tags
  @tags
end

#target ⇒ String, ... (readonly)

The ARN of the target resource.

Returns:

See Also:



65
66
67
 
# File 'pipes/cfn_pipe_props.rb', line 65

def target
  @target
end

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

The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide .

Returns:

See Also:



125
126
127
 
# File 'pipes/cfn_pipe_props.rb', line 125

def target_parameters
  @target_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'pipes/cfn_pipe_props.rb', line 127

def self.jsii_properties
  {
    :role_arn => "roleArn",
    :source => "source",
    :target => "target",
    :description => "description",
    :desired_state => "desiredState",
    :enrichment => "enrichment",
    :enrichment_parameters => "enrichmentParameters",
    :kms_key_identifier => "kmsKeyIdentifier",
    :log_configuration => "logConfiguration",
    :name => "name",
    :source_parameters => "sourceParameters",
    :tags => "tags",
    :target_parameters => "targetParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'pipes/cfn_pipe_props.rb', line 145

def to_jsii
  result = {}
  result.merge!({
    "roleArn" => @role_arn,
    "source" => @source,
    "target" => @target,
    "description" => @description,
    "desiredState" => @desired_state,
    "enrichment" => @enrichment,
    "enrichmentParameters" => @enrichment_parameters,
    "kmsKeyIdentifier" => @kms_key_identifier,
    "logConfiguration" => @log_configuration,
    "name" => @name,
    "sourceParameters" => @source_parameters,
    "tags" => @tags,
    "targetParameters" => @target_parameters,
  })
  result.compact
end