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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the metric stream.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#creation_dateTime

The date that the metric stream was created.

Returns:

  • (Time)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#exclude_filtersArray<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:



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#firehose_arnString

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

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#include_filtersArray<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:



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#include_linked_accounts_metricsBoolean

If this is ‘true` and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to.

Returns:

  • (Boolean)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#last_update_dateTime

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

Returns:

  • (Time)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#nameString

The name of the metric stream.

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#output_formatString

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

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#role_arnString

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

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#stateString

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

Returns:

  • (String)


1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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

#statistics_configurationsArray<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].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File 'lib/aws-sdk-cloudwatch/types.rb', line 1590

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