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:
Example Usage
Cloudsecuritycompliance Framework Basic
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 pulumi
import pulumi_gcp as gcp
example = gcp.cloudsecuritycompliance.Framework("example",
organization="123456789",
location="global",
framework_id="example-framework",
display_name="Terraform Framework Name",
description="An Terraform description for the framework",
cloud_control_details=[
{
"name": "organizations/123456789/locations/global/cloudControls/builtin-assess-resource-availability",
"major_revision_id": "1",
"parameters": [{
"name": "location",
"parameter_value": {
"string_value": "us-central1",
},
}],
},
{
"name": "organizations/123456789/locations/global/cloudControls/builtin-cmek-key-in-use-for-bigquery-table",
"major_revision_id": "1",
"parameters": [{
"name": "location",
"parameter_value": {
"string_list_value": {
"values": [
"us-central1",
"us-west1",
],
},
},
}],
},
{
"name": "organizations/123456789/locations/global/cloudControls/builtin-enable-automatic-backups-cloud-sql",
"major_revision_id": "1",
"parameters": [{
"name": "location",
"parameter_value": {
"bool_value": True,
},
}],
},
{
"name": "organizations/123456789/locations/global/cloudControls/builtin-require-cmek-on-bigquery-datasets",
"major_revision_id": "1",
"parameters": [{
"name": "location",
"parameter_value": {
"number_value": 1,
},
}],
},
])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/cloudsecuritycompliance"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudsecuritycompliance.NewFramework(ctx, "example", &cloudsecuritycompliance.FrameworkArgs{
Organization: pulumi.String("123456789"),
Location: pulumi.String("global"),
FrameworkId: pulumi.String("example-framework"),
DisplayName: pulumi.String("Terraform Framework Name"),
Description: pulumi.String("An Terraform description for the framework"),
CloudControlDetails: cloudsecuritycompliance.FrameworkCloudControlDetailArray{
&cloudsecuritycompliance.FrameworkCloudControlDetailArgs{
Name: pulumi.String("organizations/123456789/locations/global/cloudControls/builtin-assess-resource-availability"),
MajorRevisionId: pulumi.String("1"),
Parameters: cloudsecuritycompliance.FrameworkCloudControlDetailParameterArray{
&cloudsecuritycompliance.FrameworkCloudControlDetailParameterArgs{
Name: pulumi.String("location"),
ParameterValue: &cloudsecuritycompliance.FrameworkCloudControlDetailParameterParameterValueArgs{
StringValue: pulumi.String("us-central1"),
},
},
},
},
&cloudsecuritycompliance.FrameworkCloudControlDetailArgs{
Name: pulumi.String("organizations/123456789/locations/global/cloudControls/builtin-cmek-key-in-use-for-bigquery-table"),
MajorRevisionId: pulumi.String("1"),
Parameters: cloudsecuritycompliance.FrameworkCloudControlDetailParameterArray{
&cloudsecuritycompliance.FrameworkCloudControlDetailParameterArgs{
Name: pulumi.String("location"),
ParameterValue: &cloudsecuritycompliance.FrameworkCloudControlDetailParameterParameterValueArgs{
StringListValue: &cloudsecuritycompliance.FrameworkCloudControlDetailParameterParameterValueStringListValueArgs{
Values: pulumi.StringArray{
pulumi.String("us-central1"),
pulumi.String("us-west1"),
},
},
},
},
},
},
&cloudsecuritycompliance.FrameworkCloudControlDetailArgs{
Name: pulumi.String("organizations/123456789/locations/global/cloudControls/builtin-enable-automatic-backups-cloud-sql"),
MajorRevisionId: pulumi.String("1"),
Parameters: cloudsecuritycompliance.FrameworkCloudControlDetailParameterArray{
&cloudsecuritycompliance.FrameworkCloudControlDetailParameterArgs{
Name: pulumi.String("location"),
ParameterValue: &cloudsecuritycompliance.FrameworkCloudControlDetailParameterParameterValueArgs{
BoolValue: pulumi.Bool(true),
},
},
},
},
&cloudsecuritycompliance.FrameworkCloudControlDetailArgs{
Name: pulumi.String("organizations/123456789/locations/global/cloudControls/builtin-require-cmek-on-bigquery-datasets"),
MajorRevisionId: pulumi.String("1"),
Parameters: cloudsecuritycompliance.FrameworkCloudControlDetailParameterArray{
&cloudsecuritycompliance.FrameworkCloudControlDetailParameterArgs{
Name: pulumi.String("location"),
ParameterValue: &cloudsecuritycompliance.FrameworkCloudControlDetailParameterParameterValueArgs{
NumberValue: pulumi.Float64(1),
},
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var example = new Gcp.CloudSecurityCompliance.Framework("example", new()
{
Organization = "123456789",
Location = "global",
FrameworkId = "example-framework",
DisplayName = "Terraform Framework Name",
Description = "An Terraform description for the framework",
CloudControlDetails = new[]
{
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailArgs
{
Name = "organizations/123456789/locations/global/cloudControls/builtin-assess-resource-availability",
MajorRevisionId = "1",
Parameters = new[]
{
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterArgs
{
Name = "location",
ParameterValue = new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterParameterValueArgs
{
StringValue = "us-central1",
},
},
},
},
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailArgs
{
Name = "organizations/123456789/locations/global/cloudControls/builtin-cmek-key-in-use-for-bigquery-table",
MajorRevisionId = "1",
Parameters = new[]
{
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterArgs
{
Name = "location",
ParameterValue = new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterParameterValueArgs
{
StringListValue = new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterParameterValueStringListValueArgs
{
Values = new[]
{
"us-central1",
"us-west1",
},
},
},
},
},
},
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailArgs
{
Name = "organizations/123456789/locations/global/cloudControls/builtin-enable-automatic-backups-cloud-sql",
MajorRevisionId = "1",
Parameters = new[]
{
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterArgs
{
Name = "location",
ParameterValue = new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterParameterValueArgs
{
BoolValue = true,
},
},
},
},
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailArgs
{
Name = "organizations/123456789/locations/global/cloudControls/builtin-require-cmek-on-bigquery-datasets",
MajorRevisionId = "1",
Parameters = new[]
{
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterArgs
{
Name = "location",
ParameterValue = new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterParameterValueArgs
{
NumberValue = 1,
},
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudsecuritycompliance.Framework;
import com.pulumi.gcp.cloudsecuritycompliance.FrameworkArgs;
import com.pulumi.gcp.cloudsecuritycompliance.inputs.FrameworkCloudControlDetailArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Framework("example", FrameworkArgs.builder()
.organization("123456789")
.location("global")
.frameworkId("example-framework")
.displayName("Terraform Framework Name")
.description("An Terraform description for the framework")
.cloudControlDetails(
FrameworkCloudControlDetailArgs.builder()
.name("organizations/123456789/locations/global/cloudControls/builtin-assess-resource-availability")
.majorRevisionId("1")
.parameters(FrameworkCloudControlDetailParameterArgs.builder()
.name("location")
.parameterValue(FrameworkCloudControlDetailParameterParameterValueArgs.builder()
.stringValue("us-central1")
.build())
.build())
.build(),
FrameworkCloudControlDetailArgs.builder()
.name("organizations/123456789/locations/global/cloudControls/builtin-cmek-key-in-use-for-bigquery-table")
.majorRevisionId("1")
.parameters(FrameworkCloudControlDetailParameterArgs.builder()
.name("location")
.parameterValue(FrameworkCloudControlDetailParameterParameterValueArgs.builder()
.stringListValue(FrameworkCloudControlDetailParameterParameterValueStringListValueArgs.builder()
.values(
"us-central1",
"us-west1")
.build())
.build())
.build())
.build(),
FrameworkCloudControlDetailArgs.builder()
.name("organizations/123456789/locations/global/cloudControls/builtin-enable-automatic-backups-cloud-sql")
.majorRevisionId("1")
.parameters(FrameworkCloudControlDetailParameterArgs.builder()
.name("location")
.parameterValue(FrameworkCloudControlDetailParameterParameterValueArgs.builder()
.boolValue(true)
.build())
.build())
.build(),
FrameworkCloudControlDetailArgs.builder()
.name("organizations/123456789/locations/global/cloudControls/builtin-require-cmek-on-bigquery-datasets")
.majorRevisionId("1")
.parameters(FrameworkCloudControlDetailParameterArgs.builder()
.name("location")
.parameterValue(FrameworkCloudControlDetailParameterParameterValueArgs.builder()
.numberValue(1.0)
.build())
.build())
.build())
.build());
}
}
resources:
example:
type: gcp:cloudsecuritycompliance:Framework
properties:
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
Create Framework Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Framework(name: string, args: FrameworkArgs, opts?: CustomResourceOptions);@overload
def Framework(resource_name: str,
args: FrameworkArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Framework(resource_name: str,
opts: Optional[ResourceOptions] = None,
framework_id: Optional[str] = None,
location: Optional[str] = None,
organization: Optional[str] = None,
cloud_control_details: Optional[Sequence[FrameworkCloudControlDetailArgs]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None)func NewFramework(ctx *Context, name string, args FrameworkArgs, opts ...ResourceOption) (*Framework, error)public Framework(string name, FrameworkArgs args, CustomResourceOptions? opts = null)
public Framework(String name, FrameworkArgs args)
public Framework(String name, FrameworkArgs args, CustomResourceOptions options)
type: gcp:cloudsecuritycompliance:Framework
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FrameworkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FrameworkArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FrameworkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FrameworkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FrameworkArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var frameworkResource = new Gcp.CloudSecurityCompliance.Framework("frameworkResource", new()
{
FrameworkId = "string",
Location = "string",
Organization = "string",
CloudControlDetails = new[]
{
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailArgs
{
MajorRevisionId = "string",
Name = "string",
Parameters = new[]
{
new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterArgs
{
Name = "string",
ParameterValue = new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterParameterValueArgs
{
BoolValue = false,
NumberValue = 0,
StringListValue = new Gcp.CloudSecurityCompliance.Inputs.FrameworkCloudControlDetailParameterParameterValueStringListValueArgs
{
Values = new[]
{
"string",
},
},
StringValue = "string",
},
},
},
},
},
Description = "string",
DisplayName = "string",
});
example, err := cloudsecuritycompliance.NewFramework(ctx, "frameworkResource", &cloudsecuritycompliance.FrameworkArgs{
FrameworkId: pulumi.String("string"),
Location: pulumi.String("string"),
Organization: pulumi.String("string"),
CloudControlDetails: cloudsecuritycompliance.FrameworkCloudControlDetailArray{
&cloudsecuritycompliance.FrameworkCloudControlDetailArgs{
MajorRevisionId: pulumi.String("string"),
Name: pulumi.String("string"),
Parameters: cloudsecuritycompliance.FrameworkCloudControlDetailParameterArray{
&cloudsecuritycompliance.FrameworkCloudControlDetailParameterArgs{
Name: pulumi.String("string"),
ParameterValue: &cloudsecuritycompliance.FrameworkCloudControlDetailParameterParameterValueArgs{
BoolValue: pulumi.Bool(false),
NumberValue: pulumi.Float64(0),
StringListValue: &cloudsecuritycompliance.FrameworkCloudControlDetailParameterParameterValueStringListValueArgs{
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
StringValue: pulumi.String("string"),
},
},
},
},
},
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
})
var frameworkResource = new Framework("frameworkResource", FrameworkArgs.builder()
.frameworkId("string")
.location("string")
.organization("string")
.cloudControlDetails(FrameworkCloudControlDetailArgs.builder()
.majorRevisionId("string")
.name("string")
.parameters(FrameworkCloudControlDetailParameterArgs.builder()
.name("string")
.parameterValue(FrameworkCloudControlDetailParameterParameterValueArgs.builder()
.boolValue(false)
.numberValue(0.0)
.stringListValue(FrameworkCloudControlDetailParameterParameterValueStringListValueArgs.builder()
.values("string")
.build())
.stringValue("string")
.build())
.build())
.build())
.description("string")
.displayName("string")
.build());
framework_resource = gcp.cloudsecuritycompliance.Framework("frameworkResource",
framework_id="string",
location="string",
organization="string",
cloud_control_details=[{
"major_revision_id": "string",
"name": "string",
"parameters": [{
"name": "string",
"parameter_value": {
"bool_value": False,
"number_value": 0,
"string_list_value": {
"values": ["string"],
},
"string_value": "string",
},
}],
}],
description="string",
display_name="string")
const frameworkResource = new gcp.cloudsecuritycompliance.Framework("frameworkResource", {
frameworkId: "string",
location: "string",
organization: "string",
cloudControlDetails: [{
majorRevisionId: "string",
name: "string",
parameters: [{
name: "string",
parameterValue: {
boolValue: false,
numberValue: 0,
stringListValue: {
values: ["string"],
},
stringValue: "string",
},
}],
}],
description: "string",
displayName: "string",
});
type: gcp:cloudsecuritycompliance:Framework
properties:
cloudControlDetails:
- majorRevisionId: string
name: string
parameters:
- name: string
parameterValue:
boolValue: false
numberValue: 0
stringListValue:
values:
- string
stringValue: string
description: string
displayName: string
frameworkId: string
location: string
organization: string
Framework Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Framework resource accepts the following input properties:
- Framework
Id string - 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.
- Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Organization string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Cloud
Control List<FrameworkDetails Cloud Control Detail> - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- Description string
- The description of the framework. The maximum length is 2000 characters.
- Display
Name string - Display name of the framework. The maximum length is 200 characters.
- Framework
Id string - 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.
- Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Organization string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Cloud
Control []FrameworkDetails Cloud Control Detail Args - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- Description string
- The description of the framework. The maximum length is 2000 characters.
- Display
Name string - Display name of the framework. The maximum length is 200 characters.
- framework
Id String - 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.
- location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - organization String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - cloud
Control List<FrameworkDetails Cloud Control Detail> - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- description String
- The description of the framework. The maximum length is 2000 characters.
- display
Name String - Display name of the framework. The maximum length is 200 characters.
- framework
Id string - 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.
- location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - organization string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - cloud
Control FrameworkDetails Cloud Control Detail[] - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- description string
- The description of the framework. The maximum length is 2000 characters.
- display
Name string - Display name of the framework. The maximum length is 200 characters.
- framework_
id str - 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.
- location str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - organization str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - cloud_
control_ Sequence[Frameworkdetails Cloud Control Detail Args] - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- description str
- The description of the framework. The maximum length is 2000 characters.
- display_
name str - Display name of the framework. The maximum length is 200 characters.
- framework
Id String - 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.
- location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - organization String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - cloud
Control List<Property Map>Details - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- description String
- The description of the framework. The maximum length is 2000 characters.
- display
Name String - Display name of the framework. The maximum length is 200 characters.
Outputs
All input properties are implicitly available as output properties. Additionally, the Framework resource produces the following output properties:
- Categories List<string>
- The category of the framework.
- Id string
- The provider-assigned unique ID for this managed resource.
- Major
Revision stringId - Major revision of the framework incremented in ascending order.
- Name string
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- Supported
Cloud List<string>Providers - cloud providers supported
- Supported
Enforcement List<string>Modes - The supported enforcement modes of the framework.
- Supported
Target List<string>Resource Types - target resource types supported by the Framework.
- Type string
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- Categories []string
- The category of the framework.
- Id string
- The provider-assigned unique ID for this managed resource.
- Major
Revision stringId - Major revision of the framework incremented in ascending order.
- Name string
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- Supported
Cloud []stringProviders - cloud providers supported
- Supported
Enforcement []stringModes - The supported enforcement modes of the framework.
- Supported
Target []stringResource Types - target resource types supported by the Framework.
- Type string
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- categories List<String>
- The category of the framework.
- id String
- The provider-assigned unique ID for this managed resource.
- major
Revision StringId - Major revision of the framework incremented in ascending order.
- name String
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- supported
Cloud List<String>Providers - cloud providers supported
- supported
Enforcement List<String>Modes - The supported enforcement modes of the framework.
- supported
Target List<String>Resource Types - target resource types supported by the Framework.
- type String
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- categories string[]
- The category of the framework.
- id string
- The provider-assigned unique ID for this managed resource.
- major
Revision stringId - Major revision of the framework incremented in ascending order.
- name string
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- supported
Cloud string[]Providers - cloud providers supported
- supported
Enforcement string[]Modes - The supported enforcement modes of the framework.
- supported
Target string[]Resource Types - target resource types supported by the Framework.
- type string
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- categories Sequence[str]
- The category of the framework.
- id str
- The provider-assigned unique ID for this managed resource.
- major_
revision_ strid - Major revision of the framework incremented in ascending order.
- name str
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- supported_
cloud_ Sequence[str]providers - cloud providers supported
- supported_
enforcement_ Sequence[str]modes - The supported enforcement modes of the framework.
- supported_
target_ Sequence[str]resource_ types - target resource types supported by the Framework.
- type str
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- categories List<String>
- The category of the framework.
- id String
- The provider-assigned unique ID for this managed resource.
- major
Revision StringId - Major revision of the framework incremented in ascending order.
- name String
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- supported
Cloud List<String>Providers - cloud providers supported
- supported
Enforcement List<String>Modes - The supported enforcement modes of the framework.
- supported
Target List<String>Resource Types - target resource types supported by the Framework.
- type String
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
Look up Existing Framework Resource
Get an existing Framework resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FrameworkState, opts?: CustomResourceOptions): Framework@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
categories: Optional[Sequence[str]] = None,
cloud_control_details: Optional[Sequence[FrameworkCloudControlDetailArgs]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
framework_id: Optional[str] = None,
location: Optional[str] = None,
major_revision_id: Optional[str] = None,
name: Optional[str] = None,
organization: Optional[str] = None,
supported_cloud_providers: Optional[Sequence[str]] = None,
supported_enforcement_modes: Optional[Sequence[str]] = None,
supported_target_resource_types: Optional[Sequence[str]] = None,
type: Optional[str] = None) -> Frameworkfunc GetFramework(ctx *Context, name string, id IDInput, state *FrameworkState, opts ...ResourceOption) (*Framework, error)public static Framework Get(string name, Input<string> id, FrameworkState? state, CustomResourceOptions? opts = null)public static Framework get(String name, Output<String> id, FrameworkState state, CustomResourceOptions options)resources: _: type: gcp:cloudsecuritycompliance:Framework get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Categories List<string>
- The category of the framework.
- Cloud
Control List<FrameworkDetails Cloud Control Detail> - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- Description string
- The description of the framework. The maximum length is 2000 characters.
- Display
Name string - Display name of the framework. The maximum length is 200 characters.
- Framework
Id string - 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.
- Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Major
Revision stringId - Major revision of the framework incremented in ascending order.
- Name string
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- Organization string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Supported
Cloud List<string>Providers - cloud providers supported
- Supported
Enforcement List<string>Modes - The supported enforcement modes of the framework.
- Supported
Target List<string>Resource Types - target resource types supported by the Framework.
- Type string
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- Categories []string
- The category of the framework.
- Cloud
Control []FrameworkDetails Cloud Control Detail Args - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- Description string
- The description of the framework. The maximum length is 2000 characters.
- Display
Name string - Display name of the framework. The maximum length is 200 characters.
- Framework
Id string - 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.
- Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Major
Revision stringId - Major revision of the framework incremented in ascending order.
- Name string
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- Organization string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Supported
Cloud []stringProviders - cloud providers supported
- Supported
Enforcement []stringModes - The supported enforcement modes of the framework.
- Supported
Target []stringResource Types - target resource types supported by the Framework.
- Type string
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- categories List<String>
- The category of the framework.
- cloud
Control List<FrameworkDetails Cloud Control Detail> - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- description String
- The description of the framework. The maximum length is 2000 characters.
- display
Name String - Display name of the framework. The maximum length is 200 characters.
- framework
Id String - 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.
- location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - major
Revision StringId - Major revision of the framework incremented in ascending order.
- name String
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- organization String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - supported
Cloud List<String>Providers - cloud providers supported
- supported
Enforcement List<String>Modes - The supported enforcement modes of the framework.
- supported
Target List<String>Resource Types - target resource types supported by the Framework.
- type String
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- categories string[]
- The category of the framework.
- cloud
Control FrameworkDetails Cloud Control Detail[] - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- description string
- The description of the framework. The maximum length is 2000 characters.
- display
Name string - Display name of the framework. The maximum length is 200 characters.
- framework
Id string - 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.
- location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - major
Revision stringId - Major revision of the framework incremented in ascending order.
- name string
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- organization string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - supported
Cloud string[]Providers - cloud providers supported
- supported
Enforcement string[]Modes - The supported enforcement modes of the framework.
- supported
Target string[]Resource Types - target resource types supported by the Framework.
- type string
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- categories Sequence[str]
- The category of the framework.
- cloud_
control_ Sequence[Frameworkdetails Cloud Control Detail Args] - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- description str
- The description of the framework. The maximum length is 2000 characters.
- display_
name str - Display name of the framework. The maximum length is 200 characters.
- framework_
id str - 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.
- location str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - major_
revision_ strid - Major revision of the framework incremented in ascending order.
- name str
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- organization str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - supported_
cloud_ Sequence[str]providers - cloud providers supported
- supported_
enforcement_ Sequence[str]modes - The supported enforcement modes of the framework.
- supported_
target_ Sequence[str]resource_ types - target resource types supported by the Framework.
- type str
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
- categories List<String>
- The category of the framework.
- cloud
Control List<Property Map>Details - The details of the cloud controls directly added without any grouping in the framework. Structure is documented below.
- description String
- The description of the framework. The maximum length is 2000 characters.
- display
Name String - Display name of the framework. The maximum length is 200 characters.
- framework
Id String - 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.
- location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - major
Revision StringId - Major revision of the framework incremented in ascending order.
- name String
- Identifier. The name of the framework. Format: organizations/{organization}/locations/{{location}}/frameworks/{framework_id}
- organization String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - supported
Cloud List<String>Providers - cloud providers supported
- supported
Enforcement List<String>Modes - The supported enforcement modes of the framework.
- supported
Target List<String>Resource Types - target resource types supported by the Framework.
- type String
- The type of the framework. The default is TYPE_CUSTOM. Possible values: BUILT_IN CUSTOM
Supporting Types
FrameworkCloudControlDetail, FrameworkCloudControlDetailArgs
- Major
Revision stringId - Major revision of cloudcontrol
- Name string
- The name of the CloudControl in the format: “organizations/{organization}/locations/{location}/cloudControls/{cloud-control}”
- Parameters
List<Framework
Cloud Control Detail Parameter> - Parameters is a key-value pair that is required by the CloudControl. The specification of these parameters will be present in cloudcontrol.Eg: { "name": "location","value": "us-west-1"}. Structure is documented below.
- Major
Revision stringId - Major revision of cloudcontrol
- Name string
- The name of the CloudControl in the format: “organizations/{organization}/locations/{location}/cloudControls/{cloud-control}”
- Parameters
[]Framework
Cloud Control Detail Parameter - Parameters is a key-value pair that is required by the CloudControl. The specification of these parameters will be present in cloudcontrol.Eg: { "name": "location","value": "us-west-1"}. Structure is documented below.
- major
Revision StringId - Major revision of cloudcontrol
- name String
- The name of the CloudControl in the format: “organizations/{organization}/locations/{location}/cloudControls/{cloud-control}”
- parameters
List<Framework
Cloud Control Detail Parameter> - Parameters is a key-value pair that is required by the CloudControl. The specification of these parameters will be present in cloudcontrol.Eg: { "name": "location","value": "us-west-1"}. Structure is documented below.
- major
Revision stringId - Major revision of cloudcontrol
- name string
- The name of the CloudControl in the format: “organizations/{organization}/locations/{location}/cloudControls/{cloud-control}”
- parameters
Framework
Cloud Control Detail Parameter[] - Parameters is a key-value pair that is required by the CloudControl. The specification of these parameters will be present in cloudcontrol.Eg: { "name": "location","value": "us-west-1"}. Structure is documented below.
- major_
revision_ strid - Major revision of cloudcontrol
- name str
- The name of the CloudControl in the format: “organizations/{organization}/locations/{location}/cloudControls/{cloud-control}”
- parameters
Sequence[Framework
Cloud Control Detail Parameter] - Parameters is a key-value pair that is required by the CloudControl. The specification of these parameters will be present in cloudcontrol.Eg: { "name": "location","value": "us-west-1"}. Structure is documented below.
- major
Revision StringId - Major revision of cloudcontrol
- name String
- The name of the CloudControl in the format: “organizations/{organization}/locations/{location}/cloudControls/{cloud-control}”
- parameters List<Property Map>
- Parameters is a key-value pair that is required by the CloudControl. The specification of these parameters will be present in cloudcontrol.Eg: { "name": "location","value": "us-west-1"}. Structure is documented below.
FrameworkCloudControlDetailParameter, FrameworkCloudControlDetailParameterArgs
- Name string
- The name of the parameter.
- Parameter
Value FrameworkCloud Control Detail Parameter Parameter Value - Possible parameter value types. Structure is documented below.
- Name string
- The name of the parameter.
- Parameter
Value FrameworkCloud Control Detail Parameter Parameter Value - Possible parameter value types. Structure is documented below.
- name String
- The name of the parameter.
- parameter
Value FrameworkCloud Control Detail Parameter Parameter Value - Possible parameter value types. Structure is documented below.
- name string
- The name of the parameter.
- parameter
Value FrameworkCloud Control Detail Parameter Parameter Value - Possible parameter value types. Structure is documented below.
- name str
- The name of the parameter.
- parameter_
value FrameworkCloud Control Detail Parameter Parameter Value - Possible parameter value types. Structure is documented below.
- name String
- The name of the parameter.
- parameter
Value Property Map - Possible parameter value types. Structure is documented below.
FrameworkCloudControlDetailParameterParameterValue, FrameworkCloudControlDetailParameterParameterValueArgs
- Bool
Value bool - Represents a boolean value.
- Number
Value double - Represents a double value.
- String
List FrameworkValue Cloud Control Detail Parameter Parameter Value String List Value - A list of strings. Structure is documented below.
- String
Value string - Represents a string value.
- Bool
Value bool - Represents a boolean value.
- Number
Value float64 - Represents a double value.
- String
List FrameworkValue Cloud Control Detail Parameter Parameter Value String List Value - A list of strings. Structure is documented below.
- String
Value string - Represents a string value.
- bool
Value Boolean - Represents a boolean value.
- number
Value Double - Represents a double value.
- string
List FrameworkValue Cloud Control Detail Parameter Parameter Value String List Value - A list of strings. Structure is documented below.
- string
Value String - Represents a string value.
- bool
Value boolean - Represents a boolean value.
- number
Value number - Represents a double value.
- string
List FrameworkValue Cloud Control Detail Parameter Parameter Value String List Value - A list of strings. Structure is documented below.
- string
Value string - Represents a string value.
- bool_
value bool - Represents a boolean value.
- number_
value float - Represents a double value.
- string_
list_ Frameworkvalue Cloud Control Detail Parameter Parameter Value String List Value - A list of strings. Structure is documented below.
- string_
value str - Represents a string value.
- bool
Value Boolean - Represents a boolean value.
- number
Value Number - Represents a double value.
- string
List Property MapValue - A list of strings. Structure is documented below.
- string
Value String - Represents a string value.
FrameworkCloudControlDetailParameterParameterValueStringListValue, FrameworkCloudControlDetailParameterParameterValueStringListValueArgs
- Values List<string>
- The strings in the list.
- Values []string
- The strings in the list.
- values List<String>
- The strings in the list.
- values string[]
- The strings in the list.
- values Sequence[str]
- The strings in the list.
- values List<String>
- The strings in the list.
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:
$ 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}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
