@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
379 lines • 16.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* PolicyOrchestrator helps managing project+zone level policy resources (e.g.
* OS Policy Assignments), by providing tools to create, update and delete them
* across projects and locations, at scale.
*
* ## Example Usage
*
* ### Osconfigv2 Policy Orchestrator Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const policyOrchestrator = new gcp.osconfig.V2PolicyOrchestrator("policy_orchestrator", {
* policyOrchestratorId: "po",
* state: "ACTIVE",
* action: "UPSERT",
* orchestratedResource: {
* id: "test-orchestrated-resource",
* osPolicyAssignmentV1Payload: {
* osPolicies: [{
* id: "test-os-policy",
* mode: "VALIDATION",
* resourceGroups: [{
* resources: [{
* id: "resource-tf",
* file: {
* content: "file-content-tf",
* path: "file-path-tf-1",
* state: "PRESENT",
* },
* }],
* }],
* }],
* instanceFilter: {
* inventories: [{
* osShortName: "windows-10",
* }],
* },
* rollout: {
* disruptionBudget: {
* percent: 100,
* },
* minWaitDuration: "60s",
* },
* },
* },
* labels: {
* state: "active",
* },
* });
* ```
*
* ## Import
*
* PolicyOrchestrator can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/global/policyOrchestrators/{{policy_orchestrator_id}}`
* * `{{project}}/{{policy_orchestrator_id}}`
* * `{{policy_orchestrator_id}}`
*
* When using the `pulumi import` command, PolicyOrchestrator can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:osconfig/v2PolicyOrchestrator:V2PolicyOrchestrator default projects/{{project}}/locations/global/policyOrchestrators/{{policy_orchestrator_id}}
* $ pulumi import gcp:osconfig/v2PolicyOrchestrator:V2PolicyOrchestrator default {{project}}/{{policy_orchestrator_id}}
* $ pulumi import gcp:osconfig/v2PolicyOrchestrator:V2PolicyOrchestrator default {{policy_orchestrator_id}}
* ```
*/
export declare class V2PolicyOrchestrator extends pulumi.CustomResource {
/**
* Get an existing V2PolicyOrchestrator 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?: V2PolicyOrchestratorState, opts?: pulumi.CustomResourceOptions): V2PolicyOrchestrator;
/**
* Returns true if the given object is an instance of V2PolicyOrchestrator. 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 V2PolicyOrchestrator;
/**
* Required. Action to be done by the orchestrator in
* `projects/{project_id}/zones/{zone_id}` locations defined by the
* `orchestrationScope`. Allowed values:
* - `UPSERT` - Orchestrator will create or update target resources.
* - `DELETE` - Orchestrator will delete target resources, if they exist
*/
readonly action: pulumi.Output<string>;
/**
* Output only. Timestamp when the policy orchestrator resource 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>;
/**
* Optional. Freeform text describing the purpose of the resource.
*/
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;
}>;
/**
* Optional. 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>;
/**
* Immutable. Identifier. In form of
* * `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}`
* * `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}`
* * `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}`
*/
readonly name: pulumi.Output<string>;
/**
* Represents a resource that is being orchestrated by the policy orchestrator.
* Structure is documented below.
*/
readonly orchestratedResource: pulumi.Output<outputs.osconfig.V2PolicyOrchestratorOrchestratedResource>;
/**
* Defines a set of selectors which drive which resources are in scope of policy
* orchestration.
* Structure is documented below.
*/
readonly orchestrationScope: pulumi.Output<outputs.osconfig.V2PolicyOrchestratorOrchestrationScope | undefined>;
/**
* Describes the state of the orchestration process.
* Structure is documented below.
*/
readonly orchestrationStates: pulumi.Output<outputs.osconfig.V2PolicyOrchestratorOrchestrationState[]>;
/**
* Required. The logical identifier of the policy orchestrator, with the following
* restrictions:
* * Must contain only lowercase letters, numbers, and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
* * Must be unique within the parent.
*/
readonly policyOrchestratorId: 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 only. Set to true, if the there are ongoing changes being applied by the
* orchestrator.
*/
readonly reconciling: pulumi.Output<boolean>;
/**
* Optional. State of the orchestrator. Can be updated to change orchestrator behaviour.
* Allowed values:
* - `ACTIVE` - orchestrator is actively looking for actions to be taken.
* - `STOPPED` - orchestrator won't make any changes.
* Note: There might be more states added in the future. We use string here
* instead of an enum, to avoid the need of propagating new states to all the
* client code.
*/
readonly state: pulumi.Output<string | undefined>;
/**
* Output only. Timestamp when the policy orchestrator resource was last modified.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a V2PolicyOrchestrator 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: V2PolicyOrchestratorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering V2PolicyOrchestrator resources.
*/
export interface V2PolicyOrchestratorState {
/**
* Required. Action to be done by the orchestrator in
* `projects/{project_id}/zones/{zone_id}` locations defined by the
* `orchestrationScope`. Allowed values:
* - `UPSERT` - Orchestrator will create or update target resources.
* - `DELETE` - Orchestrator will delete target resources, if they exist
*/
action?: pulumi.Input<string | undefined>;
/**
* Output only. Timestamp when the policy orchestrator resource 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>;
/**
* Optional. Freeform text describing the purpose of the resource.
*/
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>;
/**
* Optional. 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>;
/**
* Immutable. Identifier. In form of
* * `organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id}`
* * `folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id}`
* * `projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}`
*/
name?: pulumi.Input<string | undefined>;
/**
* Represents a resource that is being orchestrated by the policy orchestrator.
* Structure is documented below.
*/
orchestratedResource?: pulumi.Input<inputs.osconfig.V2PolicyOrchestratorOrchestratedResource | undefined>;
/**
* Defines a set of selectors which drive which resources are in scope of policy
* orchestration.
* Structure is documented below.
*/
orchestrationScope?: pulumi.Input<inputs.osconfig.V2PolicyOrchestratorOrchestrationScope | undefined>;
/**
* Describes the state of the orchestration process.
* Structure is documented below.
*/
orchestrationStates?: pulumi.Input<pulumi.Input<inputs.osconfig.V2PolicyOrchestratorOrchestrationState>[] | undefined>;
/**
* Required. The logical identifier of the policy orchestrator, with the following
* restrictions:
* * Must contain only lowercase letters, numbers, and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
* * Must be unique within the parent.
*/
policyOrchestratorId?: 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 only. Set to true, if the there are ongoing changes being applied by the
* orchestrator.
*/
reconciling?: pulumi.Input<boolean | undefined>;
/**
* Optional. State of the orchestrator. Can be updated to change orchestrator behaviour.
* Allowed values:
* - `ACTIVE` - orchestrator is actively looking for actions to be taken.
* - `STOPPED` - orchestrator won't make any changes.
* Note: There might be more states added in the future. We use string here
* instead of an enum, to avoid the need of propagating new states to all the
* client code.
*/
state?: pulumi.Input<string | undefined>;
/**
* Output only. Timestamp when the policy orchestrator resource was last modified.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a V2PolicyOrchestrator resource.
*/
export interface V2PolicyOrchestratorArgs {
/**
* Required. Action to be done by the orchestrator in
* `projects/{project_id}/zones/{zone_id}` locations defined by the
* `orchestrationScope`. Allowed values:
* - `UPSERT` - Orchestrator will create or update target resources.
* - `DELETE` - Orchestrator will delete target resources, if they exist
*/
action: pulumi.Input<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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Optional. Freeform text describing the purpose of the resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* Optional. 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>;
/**
* Represents a resource that is being orchestrated by the policy orchestrator.
* Structure is documented below.
*/
orchestratedResource: pulumi.Input<inputs.osconfig.V2PolicyOrchestratorOrchestratedResource>;
/**
* Defines a set of selectors which drive which resources are in scope of policy
* orchestration.
* Structure is documented below.
*/
orchestrationScope?: pulumi.Input<inputs.osconfig.V2PolicyOrchestratorOrchestrationScope | undefined>;
/**
* Required. The logical identifier of the policy orchestrator, with the following
* restrictions:
* * Must contain only lowercase letters, numbers, and hyphens.
* * Must start with a letter.
* * Must be between 1-63 characters.
* * Must end with a number or a letter.
* * Must be unique within the parent.
*/
policyOrchestratorId: 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>;
/**
* Optional. State of the orchestrator. Can be updated to change orchestrator behaviour.
* Allowed values:
* - `ACTIVE` - orchestrator is actively looking for actions to be taken.
* - `STOPPED` - orchestrator won't make any changes.
* Note: There might be more states added in the future. We use string here
* instead of an enum, to avoid the need of propagating new states to all the
* client code.
*/
state?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=v2policyOrchestrator.d.ts.map