@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
365 lines • 15.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Create a multicast consumer association in the specified location of the current project.
*
* To get more information about MulticastConsumerAssociation, see:
*
* * [API documentation](https://docs.cloud.google.com/vpc/docs/multicast/reference/rest/v1/projects.locations.multicastConsumerAssociations)
* * How-to Guides
* * [Create Multicast Consumer Association](https://docs.cloud.google.com/vpc/docs/multicast/enable-consumer-network#add-consumer)
*
* ## Example Usage
*
* ### Network Services Multicast Consumer Association Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const network = new gcp.compute.Network("network", {
* name: "test-network-mca",
* autoCreateSubnetworks: false,
* });
* const multicastDomain = new gcp.networkservices.MulticastDomain("multicast_domain", {
* multicastDomainId: "test-domain-mca",
* location: "global",
* adminNetwork: network.id,
* connectionConfig: {
* connectionType: "SAME_VPC",
* },
* }, {
* dependsOn: [network],
* });
* const multicastDomainActivation = new gcp.networkservices.MulticastDomainActivation("multicast_domain_activation", {
* multicastDomainActivationId: "test-domain-activation-mca",
* location: "us-central1-b",
* multicastDomain: multicastDomain.id,
* });
* const mcaTest = new gcp.networkservices.MulticastConsumerAssociation("mca_test", {
* multicastConsumerAssociationId: "test-consumer-association-mca",
* location: "us-central1-b",
* network: network.id,
* multicastDomainActivation: multicastDomainActivation.id,
* }, {
* dependsOn: [network],
* });
* ```
*
* ## Import
*
* MulticastConsumerAssociation can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/multicastConsumerAssociations/{{multicast_consumer_association_id}}`
* * `{{project}}/{{location}}/{{multicast_consumer_association_id}}`
* * `{{location}}/{{multicast_consumer_association_id}}`
*
* When using the `pulumi import` command, MulticastConsumerAssociation can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networkservices/multicastConsumerAssociation:MulticastConsumerAssociation default projects/{{project}}/locations/{{location}}/multicastConsumerAssociations/{{multicast_consumer_association_id}}
* $ pulumi import gcp:networkservices/multicastConsumerAssociation:MulticastConsumerAssociation default {{project}}/{{location}}/{{multicast_consumer_association_id}}
* $ pulumi import gcp:networkservices/multicastConsumerAssociation:MulticastConsumerAssociation default {{location}}/{{multicast_consumer_association_id}}
* ```
*/
export declare class MulticastConsumerAssociation extends pulumi.CustomResource {
/**
* Get an existing MulticastConsumerAssociation 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?: MulticastConsumerAssociationState, opts?: pulumi.CustomResourceOptions): MulticastConsumerAssociation;
/**
* Returns true if the given object is an instance of MulticastConsumerAssociation. 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 MulticastConsumerAssociation;
/**
* [Output only] The timestamp when the multicast consumer association was
* created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* An optional text description of the multicast consumer association.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Labels as key-value pairs
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly location: pulumi.Output<string>;
/**
* A unique name for the multicast consumer association.
* The name is restricted to letters, numbers, and hyphen, with the first
* character a letter, and the last a letter or a number. The name must not
* exceed 48 characters.
*/
readonly multicastConsumerAssociationId: pulumi.Output<string>;
/**
* The resource name of the multicast domain activation that is in the
* same zone as this multicast consumer association.
* Use the following format:
* // `projects/*/locations/*/multicastDomainActivations/*`.
*/
readonly multicastDomainActivation: pulumi.Output<string>;
/**
* Identifier. The resource name of the multicast consumer association.
* Use the following format:
* `projects/*/locations/*/multicastConsumerAssociations/*`.
*/
readonly name: pulumi.Output<string>;
/**
* The resource name of the multicast consumer VPC network.
* Use following format:
* `projects/{project}/locations/global/networks/{network}`.
*/
readonly network: pulumi.Output<string>;
/**
* [Output only] A Compute Engine (placement
* policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview]
* that can be used to place virtual machine (VM) instances as multicast
* consumers close to the multicast infrastructure created for this domain,
* on a best effort basis.
*/
readonly placementPolicy: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* (Output)
* The state of the multicast resource.
* Possible values:
* CREATING
* ACTIVE
* DELETING
* DELETE_FAILED
* UPDATING
* UPDATE_FAILED
* INACTIVE
*/
readonly states: pulumi.Output<outputs.networkservices.MulticastConsumerAssociationState[]>;
/**
* [Output only] The Google-generated UUID for the resource. This value is
* unique across all multicast consumer association resources. If a consumer
* association is deleted and another with the same name is created, the new
* consumer association is assigned a different unique_id.
*/
readonly uniqueId: pulumi.Output<string>;
/**
* [Output only] The timestamp when the Multicast Consumer Association was
* most recently updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a MulticastConsumerAssociation 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: MulticastConsumerAssociationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MulticastConsumerAssociation resources.
*/
export interface MulticastConsumerAssociationState {
/**
* [Output only] The timestamp when the multicast consumer association was
* created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional text description of the multicast consumer association.
*/
description?: pulumi.Input<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Labels as key-value pairs
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* A unique name for the multicast consumer association.
* The name is restricted to letters, numbers, and hyphen, with the first
* character a letter, and the last a letter or a number. The name must not
* exceed 48 characters.
*/
multicastConsumerAssociationId?: pulumi.Input<string | undefined>;
/**
* The resource name of the multicast domain activation that is in the
* same zone as this multicast consumer association.
* Use the following format:
* // `projects/*/locations/*/multicastDomainActivations/*`.
*/
multicastDomainActivation?: pulumi.Input<string | undefined>;
/**
* Identifier. The resource name of the multicast consumer association.
* Use the following format:
* `projects/*/locations/*/multicastConsumerAssociations/*`.
*/
name?: pulumi.Input<string | undefined>;
/**
* The resource name of the multicast consumer VPC network.
* Use following format:
* `projects/{project}/locations/global/networks/{network}`.
*/
network?: pulumi.Input<string | undefined>;
/**
* [Output only] A Compute Engine (placement
* policy)[https://cloud.google.com/compute/docs/instances/placement-policies-overview]
* that can be used to place virtual machine (VM) instances as multicast
* consumers close to the multicast infrastructure created for this domain,
* on a best effort basis.
*/
placementPolicy?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* (Output)
* The state of the multicast resource.
* Possible values:
* CREATING
* ACTIVE
* DELETING
* DELETE_FAILED
* UPDATING
* UPDATE_FAILED
* INACTIVE
*/
states?: pulumi.Input<pulumi.Input<inputs.networkservices.MulticastConsumerAssociationState>[] | undefined>;
/**
* [Output only] The Google-generated UUID for the resource. This value is
* unique across all multicast consumer association resources. If a consumer
* association is deleted and another with the same name is created, the new
* consumer association is assigned a different unique_id.
*/
uniqueId?: pulumi.Input<string | undefined>;
/**
* [Output only] The timestamp when the Multicast Consumer Association was
* most recently updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a MulticastConsumerAssociation resource.
*/
export interface MulticastConsumerAssociationArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional text description of the multicast consumer association.
*/
description?: pulumi.Input<string | undefined>;
/**
* Labels as key-value pairs
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location: pulumi.Input<string>;
/**
* A unique name for the multicast consumer association.
* The name is restricted to letters, numbers, and hyphen, with the first
* character a letter, and the last a letter or a number. The name must not
* exceed 48 characters.
*/
multicastConsumerAssociationId: pulumi.Input<string>;
/**
* The resource name of the multicast domain activation that is in the
* same zone as this multicast consumer association.
* Use the following format:
* // `projects/*/locations/*/multicastDomainActivations/*`.
*/
multicastDomainActivation: pulumi.Input<string>;
/**
* The resource name of the multicast consumer VPC network.
* Use following format:
* `projects/{project}/locations/global/networks/{network}`.
*/
network: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=multicastConsumerAssociation.d.ts.map