Class: Aws::CloudWatch::Types::GetMetricStreamOutput

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatch::Types::GetMetricStreamOutput

Defined in:

gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the metric stream.

• #creation_date ⇒ Time

  The date that the metric stream was created.

• #exclude_filters ⇒ Array<Types::MetricStreamFilter>

  If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream.

• #firehose_arn ⇒ String

  The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.

• #include_filters ⇒ Array<Types::MetricStreamFilter>

  If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

• #last_update_date ⇒ Time

  The date of the most recent update to the metric stream's configuration.

• #name ⇒ String

  The name of the metric stream.

• #output_format ⇒ String

  The output format for the stream.

• #role_arn ⇒ String

  The ARN of the IAM role that is used by this metric stream.

• #state ⇒ String

  The state of the metric stream.

• #statistics_configurations ⇒ Array<Types::MetricStreamStatisticsConfiguration>

  Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream.

Instance Attribute Details

#arn ⇒ String

The ARN of the metric stream.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The date that the metric stream was created.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_filters ⇒ Array<Types::MetricStreamFilter>

If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream.

Returns:

• (Array<Types::MetricStreamFilter>)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#firehose_arn ⇒ String

The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#include_filters ⇒ Array<Types::MetricStreamFilter>

If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream.

Returns:

• (Array<Types::MetricStreamFilter>)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_date ⇒ Time

The date of the most recent update to the metric stream's configuration.

Returns:

• (Time)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the metric stream.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#output_format ⇒ String

The output format for the stream. Valid values are json and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the IAM role that is used by this metric stream.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of the metric stream. The possible values are running and stopped.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#statistics_configurations ⇒ Array<Types::MetricStreamStatisticsConfiguration>

Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions.

Returns:

• (Array<Types::MetricStreamStatisticsConfiguration>)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1570

class GetMetricStreamOutput < Struct.new(
  :arn,
  :name,
  :include_filters,
  :exclude_filters,
  :firehose_arn,
  :role_arn,
  :state,
  :creation_date,
  :last_update_date,
  :output_format,
  :statistics_configurations)
  SENSITIVE = []
  include Aws::Structure
end