CfnMetricStream
- class aws_cdk.aws_cloudwatch.CfnMetricStream(scope, id, *, firehose_arn, output_format, role_arn, exclude_filters=None, include_filters=None, include_linked_accounts_metrics=None, name=None, statistics_configurations=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::CloudWatch::MetricStream
.Creates or updates a metric stream. Metrics streams can automatically stream CloudWatch metrics to AWS destinations including Amazon S3 and to many third-party solutions. For more information, see Metric streams .
To create a metric stream, you must be logged on to an account that has the
iam:PassRole
permission and either the CloudWatchFullAccess policy or thecloudwatch:PutMetricStream
permission.When you create or update a metric stream, you choose one of the following:
Stream metrics from all metric namespaces in the account.
Stream metrics from all metric namespaces in the account, except for the namespaces that you list in
ExcludeFilters
.Stream metrics from only the metric namespaces that you list in
IncludeFilters
.
When you create a metric stream, the stream is created in the
running
state. If you update an existing metric stream, the state does not change.If you create a metric stream in an account that has been set up as a monitoring account in CloudWatch cross-account observability, you can choose whether to include metrics from linked source accounts in the metric stream.
- CloudformationResource:
AWS::CloudWatch::MetricStream
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_cloudwatch as cloudwatch cfn_metric_stream = cloudwatch.CfnMetricStream(self, "MyCfnMetricStream", firehose_arn="firehoseArn", output_format="outputFormat", role_arn="roleArn", # the properties below are optional exclude_filters=[cloudwatch.CfnMetricStream.MetricStreamFilterProperty( namespace="namespace", # the properties below are optional metric_names=["metricNames"] )], include_filters=[cloudwatch.CfnMetricStream.MetricStreamFilterProperty( namespace="namespace", # the properties below are optional metric_names=["metricNames"] )], include_linked_accounts_metrics=False, name="name", statistics_configurations=[cloudwatch.CfnMetricStream.MetricStreamStatisticsConfigurationProperty( additional_statistics=["additionalStatistics"], include_metrics=[cloudwatch.CfnMetricStream.MetricStreamStatisticsMetricProperty( metric_name="metricName", namespace="namespace" )] )], tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::CloudWatch::MetricStream
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
firehose_arn (
str
) – The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.output_format (
str
) – The output format for the stream. Valid values arejson
andopentelemetry0.7
For more information about metric stream output formats, see Metric streams output formats . This parameter is required.role_arn (
str
) – The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include thefirehose:PutRecord
andfirehose:PutRecordBatch
permissions.exclude_filters (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,MetricStreamFilterProperty
,Dict
[str
,Any
]]],None
]) – If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. You cannot specify bothIncludeFilters
andExcludeFilters
in the same metric stream. When you modify theIncludeFilters
orExcludeFilters
of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.include_filters (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,MetricStreamFilterProperty
,Dict
[str
,Any
]]],None
]) – If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot specify bothIncludeFilters
andExcludeFilters
in the same metric stream. When you modify theIncludeFilters
orExcludeFilters
of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.include_linked_accounts_metrics (
Union
[bool
,IResolvable
,None
]) – If you are creating a metric stream in a monitoring account, specifytrue
to include metrics from source accounts that are linked to this monitoring account, in the metric stream. The default isfalse
. For more information about linking accounts, see CloudWatch cross-account observabilityname (
Optional
[str
]) – If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region. If you are updating a metric stream, specify the name of that stream here.statistics_configurations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,MetricStreamStatisticsConfigurationProperty
,Dict
[str
,Any
]]],None
]) – By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members. For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream’sOutputFormat
. If theOutputFormat
isjson
, you can stream any additional statistic that is supported by CloudWatch , listed in CloudWatch statistics definitions . If theOutputFormat
isopentelemetry0
.7, you can stream percentile statistics (p??) .tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An array of key-value pairs to apply to the metric stream. For more information, see Tag .
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::CloudWatch::MetricStream'
- attr_arn
The ARN of the metric stream.
- CloudformationAttribute:
Arn
- attr_creation_date
The date that the metric stream was originally created.
- CloudformationAttribute:
CreationDate
- attr_last_update_date
The date that the metric stream was most recently updated.
- CloudformationAttribute:
LastUpdateDate
- attr_state
The state of the metric stream, either
running
orstopped
.- CloudformationAttribute:
State
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- exclude_filters
If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
You cannot specify both
IncludeFilters
andExcludeFilters
in the same metric stream.When you modify the
IncludeFilters
orExcludeFilters
of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
- firehose_arn
The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
- include_filters
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
You cannot specify both
IncludeFilters
andExcludeFilters
in the same metric stream.When you modify the
IncludeFilters
orExcludeFilters
of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
- include_linked_accounts_metrics
If you are creating a metric stream in a monitoring account, specify
true
to include metrics from source accounts that are linked to this monitoring account, in the metric stream.The default is
false
.For more information about linking accounts, see CloudWatch cross-account observability
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
If you are creating a new metric stream, this is the name for the new stream.
The name must be different than the names of other metric streams in this account and Region.
If you are updating a metric stream, specify the name of that stream here.
- node
The construct tree node associated with this construct.
- output_format
The output format for the stream.
Valid values are
json
andopentelemetry0.7
For more information about metric stream output formats, see Metric streams output formats .This parameter is required.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- role_arn
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.
This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the
firehose:PutRecord
andfirehose:PutRecordBatch
permissions.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- statistics_configurations
By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream’s
OutputFormat
. If theOutputFormat
isjson
, you can stream any additional statistic that is supported by CloudWatch , listed in CloudWatch statistics definitions . If theOutputFormat
isopentelemetry0
.7, you can stream percentile statistics (p??) .
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
MetricStreamFilterProperty
- class CfnMetricStream.MetricStreamFilterProperty(*, namespace, metric_names=None)
Bases:
object
This structure contains a metric namespace and optionally, a list of metric names, to either include in a metric ‘ stream or exclude from a metric stream.
A metric stream’s filters can include up to 1000 total names. This limit applies to the sum of namespace names and metric names in the filters. For example, this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with 49 metrics specified in each filter.
- Parameters:
namespace (
str
) – The name of the metric namespace in the filter. The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.metric_names (
Optional
[Sequence
[str
]]) – The names of the metrics to either include or exclude from the metric stream. If you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this filter is specified as an exclude filter or an include filter. Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name must contain at least one non-whitespace character.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_cloudwatch as cloudwatch metric_stream_filter_property = cloudwatch.CfnMetricStream.MetricStreamFilterProperty( namespace="namespace", # the properties below are optional metric_names=["metricNames"] )
Attributes
- metric_names
The names of the metrics to either include or exclude from the metric stream.
If you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this filter is specified as an exclude filter or an include filter.
Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name must contain at least one non-whitespace character.
- namespace
The name of the metric namespace in the filter.
The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.
MetricStreamStatisticsConfigurationProperty
- class CfnMetricStream.MetricStreamStatisticsConfigurationProperty(*, additional_statistics, include_metrics)
Bases:
object
This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for.
All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.
- Parameters:
additional_statistics (
Sequence
[str
]) – The additional statistics to stream for the metrics listed inIncludeMetrics
.include_metrics (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,MetricStreamStatisticsMetricProperty
,Dict
[str
,Any
]]]]) – An array that defines the metrics that are to have additional statistics streamed.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_cloudwatch as cloudwatch metric_stream_statistics_configuration_property = cloudwatch.CfnMetricStream.MetricStreamStatisticsConfigurationProperty( additional_statistics=["additionalStatistics"], include_metrics=[cloudwatch.CfnMetricStream.MetricStreamStatisticsMetricProperty( metric_name="metricName", namespace="namespace" )] )
Attributes
- additional_statistics
The additional statistics to stream for the metrics listed in
IncludeMetrics
.
- include_metrics
An array that defines the metrics that are to have additional statistics streamed.
MetricStreamStatisticsMetricProperty
- class CfnMetricStream.MetricStreamStatisticsMetricProperty(*, metric_name, namespace)
Bases:
object
A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.
- Parameters:
metric_name (
str
) – The name of the metric.namespace (
str
) – The namespace of the metric.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_cloudwatch as cloudwatch metric_stream_statistics_metric_property = cloudwatch.CfnMetricStream.MetricStreamStatisticsMetricProperty( metric_name="metricName", namespace="namespace" )
Attributes
- metric_name
The name of the metric.