CfnLink
- class aws_cdk.aws_oam.CfnLink(scope, id, *, resource_types, sink_identifier, label_template=None, link_configuration=None, tags=None)
Bases:
CfnResource
Creates a link between a source account and a sink that you have created in a monitoring account.
Before you create a link, you must create a sink in the monitoring account. The sink must have a sink policy that permits the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization, an organizational unit, or to individual accounts.
For more information, see CreateSink and PutSinkPolicy .
Each monitoring account can be linked to as many as 100,000 source accounts.
Each source account can be linked to as many as five monitoring accounts.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-oam-link.html
- CloudformationResource:
AWS::Oam::Link
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_oam as oam cfn_link = oam.CfnLink(self, "MyCfnLink", resource_types=["resourceTypes"], sink_identifier="sinkIdentifier", # the properties below are optional label_template="labelTemplate", link_configuration=oam.CfnLink.LinkConfigurationProperty( log_group_configuration=oam.CfnLink.LinkFilterProperty( filter="filter" ), metric_configuration=oam.CfnLink.LinkFilterProperty( filter="filter" ) ), tags={ "tags_key": "tags" } )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).resource_types (
Sequence
[str
]) – An array of strings that define which types of data that the source account shares with the monitoring account. Valid values areAWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor
.sink_identifier (
str
) – The ARN of the sink in the monitoring account that you want to link to. You can use ListSinks to find the ARNs of sinks.label_template (
Optional
[str
]) – Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account. You can include the following variables in your template: -$AccountName
is the name of the account -$AccountEmail
is a globally-unique email address, which includes the email domain, such asmariagarcia@example.com
-$AccountEmailNoDomain
is an email address without the domain name, such asmariagarcia
link_configuration (
Union
[IResolvable
,LinkConfigurationProperty
,Dict
[str
,Any
],None
]) – Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.tags (
Optional
[Mapping
[str
,str
]]) – An array of key-value pairs to apply to the link. 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_dependency(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_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- 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 intermediate 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
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- 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 resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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.type_hint (
Optional
[ResolutionTypeHint
]) –
- 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
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- 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
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- 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::Oam::Link'
- attr_arn
The ARN of the link.
For example,
arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
- CloudformationAttribute:
Arn
- attr_label
The friendly human-readable name used to identify this source account when it is viewed from the monitoring account.
For example,
my-account1
.- CloudformationAttribute:
Label
- 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.
- label_template
Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.
- link_configuration
Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
- 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.
- node
The tree node.
- 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 })
.
- resource_types
An array of strings that define which types of data that the source account shares with the monitoring account.
- sink_identifier
The ARN of the sink in the monitoring account that you want to link to.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
An array of key-value pairs to apply to the link.
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(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
LinkConfigurationProperty
- class CfnLink.LinkConfigurationProperty(*, log_group_configuration=None, metric_configuration=None)
Bases:
object
Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.
- Parameters:
log_group_configuration (
Union
[IResolvable
,LinkFilterProperty
,Dict
[str
,Any
],None
]) – Use this structure to filter which log groups are to share log events from this source account to the monitoring account.metric_configuration (
Union
[IResolvable
,LinkFilterProperty
,Dict
[str
,Any
],None
]) – Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_oam as oam link_configuration_property = oam.CfnLink.LinkConfigurationProperty( log_group_configuration=oam.CfnLink.LinkFilterProperty( filter="filter" ), metric_configuration=oam.CfnLink.LinkFilterProperty( filter="filter" ) )
Attributes
- log_group_configuration
Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
- metric_configuration
Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
LinkFilterProperty
- class CfnLink.LinkFilterProperty(*, filter)
Bases:
object
When used in
MetricConfiguration
this field specifies which metric namespaces are to be shared with the monitoring account.When used in
LogGroupConfiguration
this field specifies which log groups are to share their log events with the monitoring account. Use the termLogGroupName
and one or more of the following operands.- Parameters:
filter (
str
) – When used inMetricConfiguration
this field specifies which metric namespaces are to be shared with the monitoring account. When used inLogGroupConfiguration
this field specifies which log groups are to share their log events with the monitoring account. Use the termLogGroupName
and one or more of the following operands. Use single quotation marks (’) around log group names and metric namespaces. The matching of log group names and metric namespaces is case sensitive. Each filter has a limit of five conditional operands. Conditional operands areAND
andOR
. -=
and!=
-AND
-OR
-LIKE
andNOT LIKE
. These can be used only as prefix searches. Include a%
at the end of the string that you want to search for and include. -IN
andNOT IN
, using parentheses( )
Examples: -Namespace NOT LIKE 'AWS/%'
includes only namespaces that don’t start withAWS/
, such as custom namespaces. -Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')
includes only the metrics in the EC2, Elastic Load Balancing , and Amazon S3 namespaces. -Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%'
includes only the EC2 namespace and your custom namespaces. -LogGroupName IN ('This-Log-Group', 'Other-Log-Group')
includes only the log groups with namesThis-Log-Group
andOther-Log-Group
. -LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2')
includes all log groups except the log groups with namesPrivate-Log-Group
andPrivate-Log-Group-2
. -LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'
includes all log groups that have names that start withaws/lambda/
orAWSLogs
. .. epigraph:: If you are updating a link that uses filters, you can specify*
as the only value for thefilter
parameter to delete the filter and share all log groups with the monitoring account.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_oam as oam link_filter_property = oam.CfnLink.LinkFilterProperty( filter="filter" )
Attributes
- filter
When used in
MetricConfiguration
this field specifies which metric namespaces are to be shared with the monitoring account.When used in
LogGroupConfiguration
this field specifies which log groups are to share their log events with the monitoring account. Use the termLogGroupName
and one or more of the following operands.Use single quotation marks (’) around log group names and metric namespaces.
The matching of log group names and metric namespaces is case sensitive. Each filter has a limit of five conditional operands. Conditional operands are
AND
andOR
.=
and!=
AND
OR
LIKE
andNOT LIKE
. These can be used only as prefix searches. Include a%
at the end of the string that you want to search for and include.IN
andNOT IN
, using parentheses( )
Examples:
Namespace NOT LIKE 'AWS/%'
includes only namespaces that don’t start withAWS/
, such as custom namespaces.Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3')
includes only the metrics in the EC2, Elastic Load Balancing , and Amazon S3 namespaces.Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%'
includes only the EC2 namespace and your custom namespaces.LogGroupName IN ('This-Log-Group', 'Other-Log-Group')
includes only the log groups with namesThis-Log-Group
andOther-Log-Group
.LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2')
includes all log groups except the log groups with namesPrivate-Log-Group
andPrivate-Log-Group-2
.LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%'
includes all log groups that have names that start withaws/lambda/
orAWSLogs
.
If you are updating a link that uses filters, you can specify
*
as the only value for thefilter
parameter to delete the filter and share all log groups with the monitoring account.