Struct CreatePipeInput

#[non_exhaustive]
pub struct CreatePipeInput {

    pub name: Option<String>,
    pub description: Option<String>,
    pub desired_state: Option<RequestedPipeState>,
    pub source: Option<String>,
    pub source_parameters: Option<PipeSourceParameters>,
    pub enrichment: Option<String>,
    pub enrichment_parameters: Option<PipeEnrichmentParameters>,
    pub target: Option<String>,
    pub target_parameters: Option<PipeTargetParameters>,
    pub role_arn: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub log_configuration: Option<PipeLogConfigurationParameters>,
    pub kms_key_identifier: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the pipe.

description: Option<String>

A description of the pipe.

desired_state: Option<RequestedPipeState>

The state the pipe should be in.

source: Option<String>

The ARN of the source resource.

source_parameters: Option<PipeSourceParameters>

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

enrichment: Option<String>

The ARN of the enrichment resource.

enrichment_parameters: Option<PipeEnrichmentParameters>

The parameters required to set up enrichment on your pipe.

target: Option<String>

The ARN of the target resource.

target_parameters: Option<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.

role_arn: Option<String>

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

tags: Option<HashMap<String, String>>

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

log_configuration: Option<PipeLogConfigurationParameters>

The logging configuration settings for the pipe.

kms_key_identifier: Option<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.

Implementations

impl CreatePipeInput

pub fn name(&self) -> Option<&str>

The name of the pipe.

pub fn description(&self) -> Option<&str>

A description of the pipe.

pub fn desired_state(&self) -> Option<&RequestedPipeState>

The state the pipe should be in.

pub fn source(&self) -> Option<&str>

The ARN of the source resource.

pub fn source_parameters(&self) -> Option<&PipeSourceParameters>

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

pub fn enrichment(&self) -> Option<&str>

The ARN of the enrichment resource.

pub fn enrichment_parameters(&self) -> Option<&PipeEnrichmentParameters>

The parameters required to set up enrichment on your pipe.

pub fn target(&self) -> Option<&str>

The ARN of the target resource.

pub fn target_parameters(&self) -> Option<&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.

pub fn role_arn(&self) -> Option<&str>

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

pub fn log_configuration(&self) -> Option<&PipeLogConfigurationParameters>

The logging configuration settings for the pipe.

pub fn kms_key_identifier(&self) -> Option<&str>

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.

impl CreatePipeInput

pub fn builder() -> CreatePipeInputBuilder

Creates a new builder-style object to manufacture CreatePipeInput.

Trait Implementations

impl Clone for CreatePipeInput

fn clone(&self) -> CreatePipeInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreatePipeInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreatePipeInput

fn eq(&self, other: &CreatePipeInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreatePipeInput