Struct aws_sdk_pipes::operation::describe_pipe::DescribePipeOutput

#[non_exhaustive]
pub struct DescribePipeOutput {

    pub arn: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub desired_state: Option<RequestedPipeStateDescribeResponse>,
    pub current_state: Option<PipeState>,
    pub state_reason: Option<String>,
    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 creation_time: Option<DateTime>,
    pub last_modified_time: Option<DateTime>,
    pub log_configuration: Option<PipeLogConfiguration>,
    /* private fields */
}

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.

arn: Option<String>

The ARN of the pipe.

name: Option<String>

The name of the pipe.

description: Option<String>

A description of the pipe.

desired_state: Option<RequestedPipeStateDescribeResponse>

The state the pipe should be in.

current_state: Option<PipeState>

The state the pipe is in.

state_reason: Option<String>

The reason the pipe is in its current state.

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.

creation_time: Option<DateTime>

The time the pipe was created.

last_modified_time: Option<DateTime>

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

log_configuration: Option<PipeLogConfiguration>

The logging configuration settings for the pipe.

Implementations

impl DescribePipeOutput

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

The ARN of the pipe.

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<&RequestedPipeStateDescribeResponse>

The state the pipe should be in.

pub fn current_state(&self) -> Option<&PipeState>

The state the pipe is in.

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

The reason the pipe is in its current state.

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 creation_time(&self) -> Option<&DateTime>

The time the pipe was created.

pub fn last_modified_time(&self) -> Option<&DateTime>

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

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

The logging configuration settings for the pipe.

impl DescribePipeOutput

pub fn builder() -> DescribePipeOutputBuilder

Creates a new builder-style object to manufacture DescribePipeOutput.

Trait Implementations

impl Clone for DescribePipeOutput

fn clone(&self) -> DescribePipeOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribePipeOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribePipeOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for DescribePipeOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribePipeOutput