Class: Aws::Pipes::Types::CreatePipeRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pipes/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:description, :tags]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the pipe.

Returns:

  • (String) 


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#desired_state ⇒ String

The state the pipe should be in.

Returns:

  • (String) 


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#enrichment ⇒ String

The ARN of the enrichment resource.

Returns:

  • (String) 


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#enrichment_parameters ⇒ Types::PipeEnrichmentParameters

The parameters required to set up enrichment on your pipe.

Returns:



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  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.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.

For more information, see [Managing keys] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/getting-started.html

Returns:

  • (String) 


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#log_configuration ⇒ Types::PipeLogConfigurationParameters

The logging configuration settings for the pipe.

Returns:



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#name ⇒ String

The name of the pipe.

Returns:

  • (String) 


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String) 


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#source ⇒ String

The ARN of the source resource.

Returns:

  • (String) 


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#source_parameters ⇒ Types::PipeSourceParameters

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

Returns:



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#target ⇒ String

The ARN of the target resource.

Returns:

  • (String) 


518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  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*.

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html

Returns:



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/aws-sdk-pipes/types.rb', line 518

class CreatePipeRequest < Struct.new(
  :name,
  :description,
  :desired_state,
  :source,
  :source_parameters,
  :enrichment,
  :enrichment_parameters,
  :target,
  :target_parameters,
  :role_arn,
  :tags,
  :log_configuration,
  :kms_key_identifier)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end