@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
451 lines • 18.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Create a multicast group range in the current project.
*
* To get more information about MulticastGroupRange, see:
*
* * [API documentation](https://docs.cloud.google.com/vpc/docs/multicast/reference/rest/v1/projects.locations.multicastGroupRanges)
* * How-to Guides
* * [Create Multicast Group Range](https://docs.cloud.google.com/vpc/docs/multicast/create-group-ranges#create_a_group_range)
*
* ## Example Usage
*
* ### Network Services Multicast Group Range Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const network = new gcp.compute.Network("network", {
* name: "test-mgr-network",
* autoCreateSubnetworks: false,
* });
* const multicastDomain = new gcp.networkservices.MulticastDomain("multicast_domain", {
* multicastDomainId: "test-mgr-domain",
* location: "global",
* adminNetwork: network.id,
* connectionConfig: {
* connectionType: "SAME_VPC",
* },
* }, {
* dependsOn: [network],
* });
* const internalRange = new gcp.networkconnectivity.InternalRange("internal_range", {
* name: "test-mgr-internal-range",
* network: network.selfLink,
* usage: "FOR_VPC",
* peering: "FOR_SELF",
* ipCidrRange: "224.2.0.2/32",
* });
* const mgrTest = new gcp.networkservices.MulticastGroupRange("mgr_test", {
* multicastGroupRangeId: "test-mgr-group-range",
* location: "global",
* reservedInternalRange: internalRange.id,
* multicastDomain: multicastDomain.id,
* distributionScope: "INTRA_ZONE",
* });
* ```
*
* ## Import
*
* MulticastGroupRange can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/multicastGroupRanges/{{multicast_group_range_id}}`
* * `{{project}}/{{location}}/{{multicast_group_range_id}}`
* * `{{location}}/{{multicast_group_range_id}}`
*
* When using the `pulumi import` command, MulticastGroupRange can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networkservices/multicastGroupRange:MulticastGroupRange default projects/{{project}}/locations/{{location}}/multicastGroupRanges/{{multicast_group_range_id}}
* $ pulumi import gcp:networkservices/multicastGroupRange:MulticastGroupRange default {{project}}/{{location}}/{{multicast_group_range_id}}
* $ pulumi import gcp:networkservices/multicastGroupRange:MulticastGroupRange default {{location}}/{{multicast_group_range_id}}
* ```
*/
export declare class MulticastGroupRange extends pulumi.CustomResource {
/**
* Get an existing MulticastGroupRange 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?: MulticastGroupRangeState, opts?: pulumi.CustomResourceOptions): MulticastGroupRange;
/**
* Returns true if the given object is an instance of MulticastGroupRange. 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 MulticastGroupRange;
/**
* A list of consumer projects that are allowed to subscribe to the multicast
* IP addresses within the range defined by this MulticastGroupRange. The
* project can be specified using its project ID or project number. If left
* empty, then all consumer projects are allowed (unless
* requireExplicitAccept is set to true) once they have VPC networks
* associated to the multicast domain. The current max length of the accept
* list is 100.
*/
readonly consumerAcceptLists: pulumi.Output<string[] | undefined>;
/**
* [Output only] The timestamp when the multicast group range 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 group range.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Multicast group range's distribution scope. Intra-zone or intra-region
* cross-zone is supported, with default value being intra-region. Cross
* region distribution is not supported.
* Possible values:
* INTRA_ZONE
* INTRA_REGION
*/
readonly distributionScope: 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;
}>;
/**
* [Output only] The multicast group IP address range.
*/
readonly ipCidrRange: pulumi.Output<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>;
/**
* The logging configuration.
* Structure is documented below.
*/
readonly logConfig: pulumi.Output<outputs.networkservices.MulticastGroupRangeLogConfig | undefined>;
/**
* The resource name of the multicast domain in which to create this
* multicast group range.
* Use the following format:
* `projects/*/locations/global/multicastDomains/*`.
*/
readonly multicastDomain: pulumi.Output<string>;
/**
* A unique name for the multicast group range.
* 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 multicastGroupRangeId: pulumi.Output<string>;
/**
* Identifier. The resource name of the multicast group range.
* Use the following format:
* `projects/*/locations/global/multicastGroupRanges/*`.
*/
readonly name: 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;
}>;
/**
* Whether an empty consumerAcceptList will deny all consumer projects.
*/
readonly requireExplicitAccept: pulumi.Output<boolean | undefined>;
/**
* The resource name of the internal range reserved for this
* multicast group range.
* The internal range must be a Class D address (224.0.0.0 to 239.255.255.255)
* and have a prefix length >= 23.
* Use the following format:
* `projects/*/locations/global/internalRanges/*`.
*/
readonly reservedInternalRange: pulumi.Output<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.MulticastGroupRangeState[]>;
/**
* [Output only] The Google-generated UUID for the resource. This value is
* unique across all multicast group range resources. If a group
* range is deleted and another with the same name is created, the new
* group range is assigned a different unique_id.
*/
readonly uniqueId: pulumi.Output<string>;
/**
* [Output only] The timestamp when the multicast group range was most
* recently updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a MulticastGroupRange 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: MulticastGroupRangeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MulticastGroupRange resources.
*/
export interface MulticastGroupRangeState {
/**
* A list of consumer projects that are allowed to subscribe to the multicast
* IP addresses within the range defined by this MulticastGroupRange. The
* project can be specified using its project ID or project number. If left
* empty, then all consumer projects are allowed (unless
* requireExplicitAccept is set to true) once they have VPC networks
* associated to the multicast domain. The current max length of the accept
* list is 100.
*/
consumerAcceptLists?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* [Output only] The timestamp when the multicast group range 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 group range.
*/
description?: pulumi.Input<string | undefined>;
/**
* Multicast group range's distribution scope. Intra-zone or intra-region
* cross-zone is supported, with default value being intra-region. Cross
* region distribution is not supported.
* Possible values:
* INTRA_ZONE
* INTRA_REGION
*/
distributionScope?: 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>;
/**
* [Output only] The multicast group IP address range.
*/
ipCidrRange?: 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>;
/**
* The logging configuration.
* Structure is documented below.
*/
logConfig?: pulumi.Input<inputs.networkservices.MulticastGroupRangeLogConfig | undefined>;
/**
* The resource name of the multicast domain in which to create this
* multicast group range.
* Use the following format:
* `projects/*/locations/global/multicastDomains/*`.
*/
multicastDomain?: pulumi.Input<string | undefined>;
/**
* A unique name for the multicast group range.
* 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.
*/
multicastGroupRangeId?: pulumi.Input<string | undefined>;
/**
* Identifier. The resource name of the multicast group range.
* Use the following format:
* `projects/*/locations/global/multicastGroupRanges/*`.
*/
name?: 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>;
/**
* Whether an empty consumerAcceptList will deny all consumer projects.
*/
requireExplicitAccept?: pulumi.Input<boolean | undefined>;
/**
* The resource name of the internal range reserved for this
* multicast group range.
* The internal range must be a Class D address (224.0.0.0 to 239.255.255.255)
* and have a prefix length >= 23.
* Use the following format:
* `projects/*/locations/global/internalRanges/*`.
*/
reservedInternalRange?: 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.MulticastGroupRangeState>[] | undefined>;
/**
* [Output only] The Google-generated UUID for the resource. This value is
* unique across all multicast group range resources. If a group
* range is deleted and another with the same name is created, the new
* group range is assigned a different unique_id.
*/
uniqueId?: pulumi.Input<string | undefined>;
/**
* [Output only] The timestamp when the multicast group range was most
* recently updated.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a MulticastGroupRange resource.
*/
export interface MulticastGroupRangeArgs {
/**
* A list of consumer projects that are allowed to subscribe to the multicast
* IP addresses within the range defined by this MulticastGroupRange. The
* project can be specified using its project ID or project number. If left
* empty, then all consumer projects are allowed (unless
* requireExplicitAccept is set to true) once they have VPC networks
* associated to the multicast domain. The current max length of the accept
* list is 100.
*/
consumerAcceptLists?: pulumi.Input<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 group range.
*/
description?: pulumi.Input<string | undefined>;
/**
* Multicast group range's distribution scope. Intra-zone or intra-region
* cross-zone is supported, with default value being intra-region. Cross
* region distribution is not supported.
* Possible values:
* INTRA_ZONE
* INTRA_REGION
*/
distributionScope?: 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>;
/**
* The logging configuration.
* Structure is documented below.
*/
logConfig?: pulumi.Input<inputs.networkservices.MulticastGroupRangeLogConfig | undefined>;
/**
* The resource name of the multicast domain in which to create this
* multicast group range.
* Use the following format:
* `projects/*/locations/global/multicastDomains/*`.
*/
multicastDomain: pulumi.Input<string>;
/**
* A unique name for the multicast group range.
* 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.
*/
multicastGroupRangeId: 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>;
/**
* Whether an empty consumerAcceptList will deny all consumer projects.
*/
requireExplicitAccept?: pulumi.Input<boolean | undefined>;
/**
* The resource name of the internal range reserved for this
* multicast group range.
* The internal range must be a Class D address (224.0.0.0 to 239.255.255.255)
* and have a prefix length >= 23.
* Use the following format:
* `projects/*/locations/global/internalRanges/*`.
*/
reservedInternalRange: pulumi.Input<string>;
}
//# sourceMappingURL=multicastGroupRange.d.ts.map