@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
105 lines (104 loc) • 5.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Definition of AWS::Oam::Link Resource Type
*/
export declare class Link extends pulumi.CustomResource {
/**
* Get an existing Link resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Link;
/**
* Returns true if the given object is an instance of Link. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Link;
/**
* The ARN of the link. For example, `arn:aws:oam:us-west-1:111111111111:link:abcd1234-a123-456a-a12b-a123b456c789`
*/
readonly arn: pulumi.Output<string>;
/**
* The friendly human-readable name used to identify this source account when it is viewed from the monitoring account. For example, `my-account1` .
*/
readonly label: pulumi.Output<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 as `mariagarcia@example.com`
* - `$AccountEmailNoDomain` is an email address without the domain name, such as `mariagarcia`
*
* > In the and Regions, the only supported option is to use custom labels, and the `$AccountName` , `$AccountEmail` , and `$AccountEmailNoDomain` variables all resolve as *account-id* instead of the specified variable.
*/
readonly labelTemplate: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly linkConfiguration: pulumi.Output<outputs.oam.LinkConfiguration | undefined>;
/**
* 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` .
*/
readonly resourceTypes: pulumi.Output<enums.oam.LinkResourceType[]>;
/**
* The ARN of the sink in the monitoring account that you want to link to. You can use [ListSinks](https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html) to find the ARNs of sinks.
*/
readonly sinkIdentifier: pulumi.Output<string>;
/**
* Tags to apply to the link
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Create a Link resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: LinkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Link resource.
*/
export interface LinkArgs {
/**
* 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 as `mariagarcia@example.com`
* - `$AccountEmailNoDomain` is an email address without the domain name, such as `mariagarcia`
*
* > In the and Regions, the only supported option is to use custom labels, and the `$AccountName` , `$AccountEmail` , and `$AccountEmailNoDomain` variables all resolve as *account-id* instead of the specified variable.
*/
labelTemplate?: pulumi.Input<string>;
/**
* 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.
*/
linkConfiguration?: pulumi.Input<inputs.oam.LinkConfigurationArgs>;
/**
* 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` .
*/
resourceTypes: pulumi.Input<pulumi.Input<enums.oam.LinkResourceType>[]>;
/**
* The ARN of the sink in the monitoring account that you want to link to. You can use [ListSinks](https://docs.aws.amazon.com/OAM/latest/APIReference/API_ListSinks.html) to find the ARNs of sinks.
*/
sinkIdentifier: pulumi.Input<string>;
/**
* Tags to apply to the link
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}