UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

108 lines (107 loc) 3.95 kB
import * as pulumi from "@pulumi/pulumi"; /** * Provides a Synthetics Group Association resource. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.synthetics.GroupAssociation("example", { * groupName: exampleAwsSyntheticsGroup.name, * canaryArn: exampleAwsSyntheticsCanary.arn, * }); * ``` * * ## Import * * Using `pulumi import`, import CloudWatch Synthetics Group Association using the `canary_arn,group_name`. For example: * * ```sh * $ pulumi import aws:synthetics/groupAssociation:GroupAssociation example arn:aws:synthetics:us-west-2:123456789012:canary:tf-acc-test-abcd1234,examplename * ``` */ export declare class GroupAssociation extends pulumi.CustomResource { /** * Get an existing GroupAssociation 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupAssociationState, opts?: pulumi.CustomResourceOptions): GroupAssociation; /** * Returns true if the given object is an instance of GroupAssociation. 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 GroupAssociation; /** * ARN of the canary. */ readonly canaryArn: pulumi.Output<string>; readonly groupArn: pulumi.Output<string>; /** * ID of the Group. */ readonly groupId: pulumi.Output<string>; /** * Name of the group that the canary will be associated with. */ readonly groupName: pulumi.Output<string>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output<string>; /** * Create a GroupAssociation 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: GroupAssociationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering GroupAssociation resources. */ export interface GroupAssociationState { /** * ARN of the canary. */ canaryArn?: pulumi.Input<string>; groupArn?: pulumi.Input<string>; /** * ID of the Group. */ groupId?: pulumi.Input<string>; /** * Name of the group that the canary will be associated with. */ groupName?: pulumi.Input<string>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input<string>; } /** * The set of arguments for constructing a GroupAssociation resource. */ export interface GroupAssociationArgs { /** * ARN of the canary. */ canaryArn: pulumi.Input<string>; /** * Name of the group that the canary will be associated with. */ groupName: pulumi.Input<string>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input<string>; }