OrganizationSecurityPolicyAssociation class

An association for the OrganizationSecurityPolicy.

To get more information about OrganizationSecurityPolicyAssociation, see:

API documentation
How-to Guides
Associating a policy with the organization or folder

Example Usage

Organization Security Policy Association Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const securityPolicyTarget = new gcp.organizations.Folder("security_policy_target", {
    displayName: "tf-test-secpol",
    parent: "organizations/123456789",
    deletionProtection: false,
});
const policy = new gcp.compute.OrganizationSecurityPolicy("policy", {
    displayName: "tf-test",
    parent: securityPolicyTarget.name,
    type: "CLOUD_ARMOR",
});
const policyOrganizationSecurityPolicyAssociation = new gcp.compute.OrganizationSecurityPolicyAssociation("policy", {
    name: "tf-test",
    attachmentId: policy.parent,
    policyId: policy.id,
});

import pulumi
import pulumi_gcp as gcp

security_policy_target = gcp.organizations.Folder("security_policy_target",
    display_name="tf-test-secpol",
    parent="organizations/123456789",
    deletion_protection=False)
policy = gcp.compute.OrganizationSecurityPolicy("policy",
    display_name="tf-test",
    parent=security_policy_target.name,
    type="CLOUD_ARMOR")
policy_organization_security_policy_association = gcp.compute.OrganizationSecurityPolicyAssociation("policy",
    name="tf-test",
    attachment_id=policy.parent,
    policy_id=policy.id)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var securityPolicyTarget = new Gcp.Organizations.Folder("security_policy_target", new()
    {
        DisplayName = "tf-test-secpol",
        Parent = "organizations/123456789",
        DeletionProtection = false,
    });

    var policy = new Gcp.Compute.OrganizationSecurityPolicy("policy", new()
    {
        DisplayName = "tf-test",
        Parent = securityPolicyTarget.Name,
        Type = "CLOUD_ARMOR",
    });

    var policyOrganizationSecurityPolicyAssociation = new Gcp.Compute.OrganizationSecurityPolicyAssociation("policy", new()
    {
        Name = "tf-test",
        AttachmentId = policy.Parent,
        PolicyId = policy.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		securityPolicyTarget, err := organizations.NewFolder(ctx, "security_policy_target", &organizations.FolderArgs{
			DisplayName:        pulumi.String("tf-test-secpol"),
			Parent:             pulumi.String("organizations/123456789"),
			DeletionProtection: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		policy, err := compute.NewOrganizationSecurityPolicy(ctx, "policy", &compute.OrganizationSecurityPolicyArgs{
			DisplayName: pulumi.String("tf-test"),
			Parent:      securityPolicyTarget.Name,
			Type:        pulumi.String("CLOUD_ARMOR"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewOrganizationSecurityPolicyAssociation(ctx, "policy", &compute.OrganizationSecurityPolicyAssociationArgs{
			Name:         pulumi.String("tf-test"),
			AttachmentId: policy.Parent,
			PolicyId:     policy.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_organizations_folder" "security_policy_target" {
  display_name        = "tf-test-secpol"
  parent              = "organizations/123456789"
  deletion_protection = false
}
resource "gcp_compute_organizationsecuritypolicy" "policy" {
  display_name = "tf-test"
  parent       = gcp_organizations_folder.security_policy_target.name
  type         = "CLOUD_ARMOR"
}
resource "gcp_compute_organizationsecuritypolicyassociation" "policy" {
  name          = "tf-test"
  attachment_id = gcp_compute_organizationsecuritypolicy.policy.parent
  policy_id     = gcp_compute_organizationsecuritypolicy.policy.id
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Folder;
import com.pulumi.gcp.organizations.FolderArgs;
import com.pulumi.gcp.compute.OrganizationSecurityPolicy;
import com.pulumi.gcp.compute.OrganizationSecurityPolicyArgs;
import com.pulumi.gcp.compute.OrganizationSecurityPolicyAssociation;
import com.pulumi.gcp.compute.OrganizationSecurityPolicyAssociationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 securityPolicyTarget = new Folder("securityPolicyTarget", FolderArgs.builder()
            .displayName("tf-test-secpol")
            .parent("organizations/123456789")
            .deletionProtection(false)
            .build());

        var policy = new OrganizationSecurityPolicy("policy", OrganizationSecurityPolicyArgs.builder()
            .displayName("tf-test")
            .parent(securityPolicyTarget.name())
            .type("CLOUD_ARMOR")
            .build());

        var policyOrganizationSecurityPolicyAssociation = new OrganizationSecurityPolicyAssociation("policyOrganizationSecurityPolicyAssociation", OrganizationSecurityPolicyAssociationArgs.builder()
            .name("tf-test")
            .attachmentId(policy.parent())
            .policyId(policy.id())
            .build());

    }
}

resources:
  securityPolicyTarget:
    type: gcp:organizations:Folder
    name: security_policy_target
    properties:
      displayName: tf-test-secpol
      parent: organizations/123456789
      deletionProtection: false
  policy:
    type: gcp:compute:OrganizationSecurityPolicy
    properties:
      displayName: tf-test
      parent: ${securityPolicyTarget.name}
      type: CLOUD_ARMOR
  policyOrganizationSecurityPolicyAssociation:
    type: gcp:compute:OrganizationSecurityPolicyAssociation
    name: policy
    properties:
      name: tf-test
      attachmentId: ${policy.parent}
      policyId: ${policy.id}

Organization Security Policy Association Excluded

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const securityPolicyTarget = new gcp.organizations.Folder("security_policy_target", {
    displayName: "tf-test-secpol-_75223",
    parent: "organizations/123456789",
    deletionProtection: false,
});
const policy = new gcp.compute.OrganizationSecurityPolicy("policy", {
    shortName: "tf-test_41819",
    parent: securityPolicyTarget.name,
    type: "CLOUD_ARMOR",
});
const policyOrganizationSecurityPolicyAssociation = new gcp.compute.OrganizationSecurityPolicyAssociation("policy", {
    name: "tf-test",
    attachmentId: "organizations/123456789",
    policyId: policy.id,
    excludedProjects: [
        "projects/2000000002",
        "projects/3000000003",
    ],
    excludedFolders: [
        "folders/4000000004",
        "folders/5000000005",
    ],
});

import pulumi
import pulumi_gcp as gcp

security_policy_target = gcp.organizations.Folder("security_policy_target",
    display_name="tf-test-secpol-_75223",
    parent="organizations/123456789",
    deletion_protection=False)
policy = gcp.compute.OrganizationSecurityPolicy("policy",
    short_name="tf-test_41819",
    parent=security_policy_target.name,
    type="CLOUD_ARMOR")
policy_organization_security_policy_association = gcp.compute.OrganizationSecurityPolicyAssociation("policy",
    name="tf-test",
    attachment_id="organizations/123456789",
    policy_id=policy.id,
    excluded_projects=[
        "projects/2000000002",
        "projects/3000000003",
    ],
    excluded_folders=[
        "folders/4000000004",
        "folders/5000000005",
    ])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var securityPolicyTarget = new Gcp.Organizations.Folder("security_policy_target", new()
    {
        DisplayName = "tf-test-secpol-_75223",
        Parent = "organizations/123456789",
        DeletionProtection = false,
    });

    var policy = new Gcp.Compute.OrganizationSecurityPolicy("policy", new()
    {
        ShortName = "tf-test_41819",
        Parent = securityPolicyTarget.Name,
        Type = "CLOUD_ARMOR",
    });

    var policyOrganizationSecurityPolicyAssociation = new Gcp.Compute.OrganizationSecurityPolicyAssociation("policy", new()
    {
        Name = "tf-test",
        AttachmentId = "organizations/123456789",
        PolicyId = policy.Id,
        ExcludedProjects = new[]
        {
            "projects/2000000002",
            "projects/3000000003",
        },
        ExcludedFolders = new[]
        {
            "folders/4000000004",
            "folders/5000000005",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		securityPolicyTarget, err := organizations.NewFolder(ctx, "security_policy_target", &organizations.FolderArgs{
			DisplayName:        pulumi.String("tf-test-secpol-_75223"),
			Parent:             pulumi.String("organizations/123456789"),
			DeletionProtection: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		policy, err := compute.NewOrganizationSecurityPolicy(ctx, "policy", &compute.OrganizationSecurityPolicyArgs{
			ShortName: pulumi.String("tf-test_41819"),
			Parent:    securityPolicyTarget.Name,
			Type:      pulumi.String("CLOUD_ARMOR"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewOrganizationSecurityPolicyAssociation(ctx, "policy", &compute.OrganizationSecurityPolicyAssociationArgs{
			Name:         pulumi.String("tf-test"),
			AttachmentId: pulumi.String("organizations/123456789"),
			PolicyId:     policy.ID().ToIDOutput().ToStringOutput(),
			ExcludedProjects: pulumi.StringArray{
				pulumi.String("projects/2000000002"),
				pulumi.String("projects/3000000003"),
			},
			ExcludedFolders: pulumi.StringArray{
				pulumi.String("folders/4000000004"),
				pulumi.String("folders/5000000005"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_organizations_folder" "security_policy_target" {
  display_name        = "tf-test-secpol-_75223"
  parent              = "organizations/123456789"
  deletion_protection = false
}
resource "gcp_compute_organizationsecuritypolicy" "policy" {
  short_name = "tf-test_41819"
  parent     = gcp_organizations_folder.security_policy_target.name
  type       = "CLOUD_ARMOR"
}
resource "gcp_compute_organizationsecuritypolicyassociation" "policy" {
  name              = "tf-test"
  attachment_id     = "organizations/123456789"
  policy_id         = gcp_compute_organizationsecuritypolicy.policy.id
  excluded_projects = ["projects/2000000002", "projects/3000000003"]
  excluded_folders  = ["folders/4000000004", "folders/5000000005"]
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Folder;
import com.pulumi.gcp.organizations.FolderArgs;
import com.pulumi.gcp.compute.OrganizationSecurityPolicy;
import com.pulumi.gcp.compute.OrganizationSecurityPolicyArgs;
import com.pulumi.gcp.compute.OrganizationSecurityPolicyAssociation;
import com.pulumi.gcp.compute.OrganizationSecurityPolicyAssociationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 securityPolicyTarget = new Folder("securityPolicyTarget", FolderArgs.builder()
            .displayName("tf-test-secpol-_75223")
            .parent("organizations/123456789")
            .deletionProtection(false)
            .build());

        var policy = new OrganizationSecurityPolicy("policy", OrganizationSecurityPolicyArgs.builder()
            .shortName("tf-test_41819")
            .parent(securityPolicyTarget.name())
            .type("CLOUD_ARMOR")
            .build());

        var policyOrganizationSecurityPolicyAssociation = new OrganizationSecurityPolicyAssociation("policyOrganizationSecurityPolicyAssociation", OrganizationSecurityPolicyAssociationArgs.builder()
            .name("tf-test")
            .attachmentId("organizations/123456789")
            .policyId(policy.id())
            .excludedProjects(
                "projects/2000000002",
                "projects/3000000003")
            .excludedFolders(
                "folders/4000000004",
                "folders/5000000005")
            .build());

    }
}

resources:
  securityPolicyTarget:
    type: gcp:organizations:Folder
    name: security_policy_target
    properties:
      displayName: tf-test-secpol-_75223
      parent: organizations/123456789
      deletionProtection: false
  policy:
    type: gcp:compute:OrganizationSecurityPolicy
    properties:
      shortName: tf-test_41819
      parent: ${securityPolicyTarget.name}
      type: CLOUD_ARMOR
  policyOrganizationSecurityPolicyAssociation:
    type: gcp:compute:OrganizationSecurityPolicyAssociation
    name: policy
    properties:
      name: tf-test
      attachmentId: organizations/123456789
      policyId: ${policy.id}
      excludedProjects:
        - projects/2000000002
        - projects/3000000003
      excludedFolders:
        - folders/4000000004
        - folders/5000000005

Import

OrganizationSecurityPolicyAssociation can be imported using any of these accepted formats:

{{policy_id}}/association/{{name}}

When using the pulumi import command, OrganizationSecurityPolicyAssociation can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/organizationSecurityPolicyAssociation:OrganizationSecurityPolicyAssociation default {{policy_id}}/association/{{name}}

Constructors

OrganizationSecurityPolicyAssociation(String name, {OrganizationSecurityPolicyAssociationArgs? args, CustomResourceOptions? options}): Creates a new OrganizationSecurityPolicyAssociation. name The Pulumi resource name. args Arguments used to configure this OrganizationSecurityPolicyAssociation. The set of arguments for OrganizationSecurityPolicyAssociation. options Resource options controlling this resource's behavior.
OrganizationSecurityPolicyAssociation.reference(String urn): Creates a typed reference to an existing OrganizationSecurityPolicyAssociation resource.

Properties

attachmentId ↔ Output<String>: The resource that the security policy is attached to.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ 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.
latefinal
displayName ↔ Output<String>: The display name of the security policy of the association.
latefinal
excludedFolders ↔ Output<List<String>?>: A list of folders to exclude from the security policy.
latefinal
excludedProjects ↔ Output<List<String>?>: A list of projects to exclude from the security policy.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>: The name for an association.
latefinal
policyId ↔ Output<String>: The security policy ID of the association.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {OrganizationSecurityPolicyAssociationState? state, CustomResourceOptions? options}) → OrganizationSecurityPolicyAssociation: Gets an existing OrganizationSecurityPolicyAssociation resource's state with the given name and id.