We recommend new projects start with resources from the AWS provider.
aws-native.oam.Link
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Oam::Link Resource Type
Create Link Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Link(name: string, args: LinkArgs, opts?: CustomResourceOptions);
@overload
def Link(resource_name: str,
args: LinkArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Link(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_types: Optional[Sequence[LinkResourceType]] = None,
sink_identifier: Optional[str] = None,
label_template: Optional[str] = None,
link_configuration: Optional[LinkConfigurationArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewLink(ctx *Context, name string, args LinkArgs, opts ...ResourceOption) (*Link, error)
public Link(string name, LinkArgs args, CustomResourceOptions? opts = null)
type: aws-native:oam:Link
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args LinkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args LinkArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args LinkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LinkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LinkArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Link Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Link resource accepts the following input properties:
- Resource
Types List<Pulumi.Aws Native. Oam. Link Resource Type> - An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are
AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor
. - Sink
Identifier string - 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 string 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 Pulumi.Aws Native. Oam. Inputs. 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.
- Dictionary<string, string>
- Tags to apply to the link
- Resource
Types []LinkResource Type - An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are
AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor
. - Sink
Identifier string - 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 string 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 LinkConfiguration Args - 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.
- map[string]string
- Tags to apply to the link
- resource
Types List<LinkResource Type> - An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are
AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor
. - sink
Identifier String - 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 String 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 LinkConfiguration - 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.
- Map<String,String>
- Tags to apply to the link
- resource
Types LinkResource Type[] - An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are
AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor
. - sink
Identifier string - 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 string 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 LinkConfiguration - 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.
- {[key: string]: string}
- Tags to apply to the link
- resource_
types Sequence[LinkResource Type] - An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are
AWS::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 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 LinkConfiguration Args - 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.
- Mapping[str, str]
- Tags to apply to the link
- resource
Types List<"AWS::CloudWatch::Metric" | "AWS::Logs::Log Group" | "AWS::XRay::Trace" | "AWS::Application Insights::Application" | "AWS::Internet Monitor::Monitor"> - An array of strings that define which types of data that the source account shares with the monitoring account. Valid values are
AWS::CloudWatch::Metric | AWS::Logs::LogGroup | AWS::XRay::Trace | AWS::ApplicationInsights::Application | AWS::InternetMonitor::Monitor
. - sink
Identifier String - 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 String 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 Property Map - 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.
- Map<String>
- Tags to apply to the link
Outputs
All input properties are implicitly available as output properties. Additionally, the Link resource produces the following output properties:
- Arn string
- The ARN of the link. For example,
arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
- Id string
- The provider-assigned unique ID for this managed resource.
- Label string
- The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example,
my-account1
.
- Arn string
- The ARN of the link. For example,
arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
- Id string
- The provider-assigned unique ID for this managed resource.
- Label string
- The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example,
my-account1
.
- arn String
- The ARN of the link. For example,
arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
- id String
- The provider-assigned unique ID for this managed resource.
- label String
- The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example,
my-account1
.
- arn string
- The ARN of the link. For example,
arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
- id string
- The provider-assigned unique ID for this managed resource.
- label string
- The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example,
my-account1
.
- arn str
- The ARN of the link. For example,
arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
- id str
- The provider-assigned unique ID for this managed resource.
- label str
- The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example,
my-account1
.
- arn String
- The ARN of the link. For example,
arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789
- id String
- The provider-assigned unique ID for this managed resource.
- label String
- The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example,
my-account1
.
Supporting Types
LinkConfiguration, LinkConfigurationArgs
- Log
Group Pulumi.Configuration Aws Native. Oam. Inputs. Link Filter - Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
- Metric
Configuration Pulumi.Aws Native. Oam. Inputs. Link Filter - Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
- Log
Group LinkConfiguration Filter - Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
- Metric
Configuration LinkFilter - Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
- log
Group LinkConfiguration Filter - Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
- metric
Configuration LinkFilter - Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
- log
Group LinkConfiguration Filter - Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
- metric
Configuration LinkFilter - Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
- log_
group_ Linkconfiguration Filter - Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
- metric_
configuration LinkFilter - Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
- log
Group Property MapConfiguration - Use this structure to filter which log groups are to share log events from this source account to the monitoring account.
- metric
Configuration Property Map - Use this structure to filter which metric namespaces are to be shared from the source account to the monitoring account.
LinkFilter, LinkFilterArgs
- Filter string
When used in
MetricConfiguration
this field specifies which metric namespaces are to be shared with the monitoring accountWhen 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.
- Filter string
When used in
MetricConfiguration
this field specifies which metric namespaces are to be shared with the monitoring accountWhen 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.
- filter String
When used in
MetricConfiguration
this field specifies which metric namespaces are to be shared with the monitoring accountWhen 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.
- filter string
When used in
MetricConfiguration
this field specifies which metric namespaces are to be shared with the monitoring accountWhen 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.
- filter str
When used in
MetricConfiguration
this field specifies which metric namespaces are to be shared with the monitoring accountWhen 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.
- filter String
When used in
MetricConfiguration
this field specifies which metric namespaces are to be shared with the monitoring accountWhen 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.
LinkResourceType, LinkResourceTypeArgs
- Aws
Cloud Watch Metric - AWS::CloudWatch::Metric
- Aws
Logs Log Group - AWS::Logs::LogGroup
- Awsx
Ray Trace - AWS::XRay::Trace
- Aws
Application Insights Application - AWS::ApplicationInsights::Application
- Aws
Internet Monitor Monitor - AWS::InternetMonitor::Monitor
- Link
Resource Type Aws Cloud Watch Metric - AWS::CloudWatch::Metric
- Link
Resource Type Aws Logs Log Group - AWS::Logs::LogGroup
- Link
Resource Type Awsx Ray Trace - AWS::XRay::Trace
- Link
Resource Type Aws Application Insights Application - AWS::ApplicationInsights::Application
- Link
Resource Type Aws Internet Monitor Monitor - AWS::InternetMonitor::Monitor
- Aws
Cloud Watch Metric - AWS::CloudWatch::Metric
- Aws
Logs Log Group - AWS::Logs::LogGroup
- Awsx
Ray Trace - AWS::XRay::Trace
- Aws
Application Insights Application - AWS::ApplicationInsights::Application
- Aws
Internet Monitor Monitor - AWS::InternetMonitor::Monitor
- Aws
Cloud Watch Metric - AWS::CloudWatch::Metric
- Aws
Logs Log Group - AWS::Logs::LogGroup
- Awsx
Ray Trace - AWS::XRay::Trace
- Aws
Application Insights Application - AWS::ApplicationInsights::Application
- Aws
Internet Monitor Monitor - AWS::InternetMonitor::Monitor
- AWS_CLOUD_WATCH_METRIC
- AWS::CloudWatch::Metric
- AWS_LOGS_LOG_GROUP
- AWS::Logs::LogGroup
- AWSX_RAY_TRACE
- AWS::XRay::Trace
- AWS_APPLICATION_INSIGHTS_APPLICATION
- AWS::ApplicationInsights::Application
- AWS_INTERNET_MONITOR_MONITOR
- AWS::InternetMonitor::Monitor
- "AWS::Cloud
Watch::Metric" - AWS::CloudWatch::Metric
- "AWS::Logs::Log
Group" - AWS::Logs::LogGroup
- "AWS::XRay::Trace"
- AWS::XRay::Trace
- "AWS::Application
Insights::Application" - AWS::ApplicationInsights::Application
- "AWS::Internet
Monitor::Monitor" - AWS::InternetMonitor::Monitor
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.