import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Frameworks allow you to monitor and enforce compliance and security requirements. Manage compliance by assigning built-in or custom frameworks to resources. * * To get more information about Framework, see: * * * [API documentation](https://docs.cloud.google.com/security-command-center/docs/reference/cloudsecuritycompliance/rest/v1/organizations.locations.frameworks) * * ## Example Usage * * ### Cloudsecuritycompliance Framework Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.cloudsecuritycompliance.Framework("example", { * organization: "123456789", * location: "global", * frameworkId: "example-framework", * displayName: "Terraform Framework Name", * description: "An Terraform description for the framework", * cloudControlDetails: [ * { * name: "organizations/123456789/locations/global/cloudControls/builtin-assess-resource-availability", * majorRevisionId: "1", * parameters: [{ * name: "location", * parameterValue: { * stringValue: "us-central1", * }, * }], * }, * { * name: "organizations/123456789/locations/global/cloudControls/builtin-cmek-key-in-use-for-bigquery-table", * majorRevisionId: "1", * parameters: [{ * name: "location", * parameterValue: { * stringListValue: { * values: [ * "us-central1", * "us-west1", * ], * }, * }, * }], * }, * { * name: "organizations/123456789/locations/global/cloudControls/builtin-enable-automatic-backups-cloud-sql", * majorRevisionId: "1", * parameters: [{ * name: "location", * parameterValue: { * boolValue: true, * }, * }], * }, * { * name: "organizations/123456789/locations/global/cloudControls/builtin-require-cmek-on-bigquery-datasets", * majorRevisionId: "1", * parameters: [{ * name: "location", * parameterValue: { * numberValue: 1, * }, * }], * }, * ], * }); * ``` * * ## Import * * Framework can be imported using any of these accepted formats: * * * `organizations/{{organization}}/locations/{{location}}/frameworks/{{framework_id}}` * * `{{organization}}/{{location}}/{{framework_id}}` * * When using the `pulumi import` command, Framework can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:cloudsecuritycompliance/framework:Framework default organizations/{{organization}}/locations/{{location}}/frameworks/{{framework_id}} * $ pulumi import gcp:cloudsecuritycompliance/framework:Framework default {{organization}}/{{location}}/{{framework_id}} * ``` */ export declare class Framework extends pulumi.CustomResource { /** * Get an existing Framework 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, state?: FrameworkState, opts?: pulumi.CustomResourceOptions): Framework; /** * Returns true if the given object is an instance of Framework. 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 Framework; /** * The category of the framework. */ readonly categories: pulumi.Output; /** * The details of the cloud controls directly added without any grouping in * the framework. * Structure is documented below. */ readonly cloudControlDetails: pulumi.Output; /** * 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; /** * The description of the framework. The maximum length is 2000 characters. */ readonly description: pulumi.Output; /** * Display name of the framework. The maximum length is 200 characters. */ readonly displayName: pulumi.Output; /** * ID of the framework. * This is not the full name of the framework. * This is the last part of the full name of the framework. */ readonly frameworkId: pulumi.Output; /** * 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; /** * Major revision of the framework incremented in ascending order. */ readonly majorRevisionId: pulumi.Output; /** * Identifier. The name of the framework. * Format: * organizations/{organization}/locations/{{location}}/frameworks/{framework_id} */ readonly name: pulumi.Output; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ readonly organization: pulumi.Output; /** * cloud providers supported */ readonly supportedCloudProviders: pulumi.Output; /** * The supported enforcement modes of the framework. */ readonly supportedEnforcementModes: pulumi.Output; /** * target resource types supported by the Framework. */ readonly supportedTargetResourceTypes: pulumi.Output; /** * The type of the framework. The default is TYPE_CUSTOM. * Possible values: * BUILT_IN * CUSTOM */ readonly type: pulumi.Output; /** * Create a Framework 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: FrameworkArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Framework resources. */ export interface FrameworkState { /** * The category of the framework. */ categories?: pulumi.Input[] | undefined>; /** * The details of the cloud controls directly added without any grouping in * the framework. * Structure is documented below. */ cloudControlDetails?: pulumi.Input[] | 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; /** * The description of the framework. The maximum length is 2000 characters. */ description?: pulumi.Input; /** * Display name of the framework. The maximum length is 200 characters. */ displayName?: pulumi.Input; /** * ID of the framework. * This is not the full name of the framework. * This is the last part of the full name of the framework. */ frameworkId?: pulumi.Input; /** * 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; /** * Major revision of the framework incremented in ascending order. */ majorRevisionId?: pulumi.Input; /** * Identifier. The name of the framework. * Format: * organizations/{organization}/locations/{{location}}/frameworks/{framework_id} */ name?: pulumi.Input; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ organization?: pulumi.Input; /** * cloud providers supported */ supportedCloudProviders?: pulumi.Input[] | undefined>; /** * The supported enforcement modes of the framework. */ supportedEnforcementModes?: pulumi.Input[] | undefined>; /** * target resource types supported by the Framework. */ supportedTargetResourceTypes?: pulumi.Input[] | undefined>; /** * The type of the framework. The default is TYPE_CUSTOM. * Possible values: * BUILT_IN * CUSTOM */ type?: pulumi.Input; } /** * The set of arguments for constructing a Framework resource. */ export interface FrameworkArgs { /** * The details of the cloud controls directly added without any grouping in * the framework. * Structure is documented below. */ cloudControlDetails?: pulumi.Input[] | 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; /** * The description of the framework. The maximum length is 2000 characters. */ description?: pulumi.Input; /** * Display name of the framework. The maximum length is 200 characters. */ displayName?: pulumi.Input; /** * ID of the framework. * This is not the full name of the framework. * This is the last part of the full name of the framework. */ frameworkId: pulumi.Input; /** * 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; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ organization: pulumi.Input; } //# sourceMappingURL=framework.d.ts.map