Class: Aws::Pipes::Types::UpdatePipeRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pipes::Types::UpdatePipeRequest
- Defined in:
- gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:description]
Instance Attribute Summary collapse
-
#description ⇒ String
A description of the pipe.
-
#desired_state ⇒ String
The state the pipe should be in.
-
#enrichment ⇒ String
The ARN of the enrichment resource.
-
#enrichment_parameters ⇒ Types::PipeEnrichmentParameters
The parameters required to set up enrichment on your pipe.
-
#kms_key_identifier ⇒ String
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data.
-
#log_configuration ⇒ Types::PipeLogConfigurationParameters
The logging configuration settings for the pipe.
-
#name ⇒ String
The name of the pipe.
-
#role_arn ⇒ String
The ARN of the role that allows the pipe to send data to the target.
-
#source_parameters ⇒ Types::UpdatePipeSourceParameters
The parameters required to set up a source for your pipe.
-
#target ⇒ String
The ARN of the target resource.
-
#target_parameters ⇒ Types::PipeTargetParameters
The parameters required to set up a target for your pipe.
Instance Attribute Details
#description ⇒ String
A description of the pipe.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#desired_state ⇒ String
The state the pipe should be in.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#enrichment ⇒ String
The ARN of the enrichment resource.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#enrichment_parameters ⇒ Types::PipeEnrichmentParameters
The parameters required to set up enrichment on your pipe.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#kms_key_identifier ⇒ String
The identifier of the KMS 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 Amazon Web Services 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 Amazon Web Services owned key, specify an empty string.
For more information, see Managing keys in the Key Management Service Developer Guide.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#log_configuration ⇒ Types::PipeLogConfigurationParameters
The logging configuration settings for the pipe.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#name ⇒ String
The name of the pipe.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#role_arn ⇒ String
The ARN of the role that allows the pipe to send data to the target.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#source_parameters ⇒ Types::UpdatePipeSourceParameters
The parameters required to set up a source for your pipe.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#target ⇒ String
The ARN of the target resource.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |
#target_parameters ⇒ Types::PipeTargetParameters
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.
3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 3325 class UpdatePipeRequest < Struct.new( :name, :description, :desired_state, :source_parameters, :enrichment, :enrichment_parameters, :target, :target_parameters, :role_arn, :log_configuration, :kms_key_identifier) SENSITIVE = [:description] include Aws::Structure end |