@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
240 lines • 10.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A Mirroring Engine is a logical representation of the underlying infrastructure
* that is used to manage and monitor the ULL Mirroring setup.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* ## Example Usage
*
* ### Network Security Ull Mirroring Engine Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.networksecurity.UllMirroringEngine("default", {
* ullMirroringEngineId: "example-ull-eng",
* location: "us-south1-d",
* labels: {
* foo: "bar",
* },
* });
* ```
*
* ## Import
*
* UllMirroringEngine can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/ullMirroringEngines/{{ull_mirroring_engine_id}}`
* * `{{project}}/{{location}}/{{ull_mirroring_engine_id}}`
* * `{{location}}/{{ull_mirroring_engine_id}}`
*
* When using the `pulumi import` command, UllMirroringEngine can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networksecurity/ullMirroringEngine:UllMirroringEngine default projects/{{project}}/locations/{{location}}/ullMirroringEngines/{{ull_mirroring_engine_id}}
* $ pulumi import gcp:networksecurity/ullMirroringEngine:UllMirroringEngine default {{project}}/{{location}}/{{ull_mirroring_engine_id}}
* $ pulumi import gcp:networksecurity/ullMirroringEngine:UllMirroringEngine default {{location}}/{{ull_mirroring_engine_id}}
* ```
*/
export declare class UllMirroringEngine extends pulumi.CustomResource {
/**
* Get an existing UllMirroringEngine 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?: UllMirroringEngineState, opts?: pulumi.CustomResourceOptions): UllMirroringEngine;
/**
* Returns true if the given object is an instance of UllMirroringEngine. 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 UllMirroringEngine;
/**
* The timestamp when the resource was created.
* See https://google.aip.dev/148#timestamps.
*/
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>;
/**
* 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 are key/value pairs that help to organize and filter resources.
* **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>;
/**
* The cloud location of the engine, e.g. `us-south1-d` or `us-south1-e`.
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of this engine, for example:
* `projects/123456789/locations/us-south1-d/ullMirroringEngines/my-engine`.
* See https://google.aip.dev/122 for more details.
*/
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;
}>;
/**
* The current state of the resource does not match the user's intended state,
* and the system is working to reconcile them. This is part of the normal
* operation. See https://google.aip.dev/128.
*/
readonly reconciling: pulumi.Output<boolean>;
/**
* The ID to use for the new engine, which will become the final
* component of the engine's resource name.
*/
readonly ullMirroringEngineId: pulumi.Output<string>;
/**
* The timestamp when the resource was most recently updated.
* See https://google.aip.dev/148#timestamps.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a UllMirroringEngine 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: UllMirroringEngineArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering UllMirroringEngine resources.
*/
export interface UllMirroringEngineState {
/**
* The timestamp when the resource was created.
* See https://google.aip.dev/148#timestamps.
*/
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>;
/**
* 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 are key/value pairs that help to organize and filter resources.
* **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>;
/**
* The cloud location of the engine, e.g. `us-south1-d` or `us-south1-e`.
*/
location?: pulumi.Input<string | undefined>;
/**
* The resource name of this engine, for example:
* `projects/123456789/locations/us-south1-d/ullMirroringEngines/my-engine`.
* See https://google.aip.dev/122 for more details.
*/
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>;
/**
* The current state of the resource does not match the user's intended state,
* and the system is working to reconcile them. This is part of the normal
* operation. See https://google.aip.dev/128.
*/
reconciling?: pulumi.Input<boolean | undefined>;
/**
* The ID to use for the new engine, which will become the final
* component of the engine's resource name.
*/
ullMirroringEngineId?: pulumi.Input<string | undefined>;
/**
* The timestamp when the resource was most recently updated.
* See https://google.aip.dev/148#timestamps.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a UllMirroringEngine resource.
*/
export interface UllMirroringEngineArgs {
/**
* 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>;
/**
* Labels are key/value pairs that help to organize and filter resources.
* **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>;
/**
* The cloud location of the engine, e.g. `us-south1-d` or `us-south1-e`.
*/
location: 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>;
/**
* The ID to use for the new engine, which will become the final
* component of the engine's resource name.
*/
ullMirroringEngineId: pulumi.Input<string>;
}
//# sourceMappingURL=ullMirroringEngine.d.ts.map