pulumi-gcp-kotlin/com.pulumi.gcp.projects.kotlin/AccessApprovalSettings

AccessApprovalSettings

class AccessApprovalSettings : KotlinCustomResource

Access Approval enables you to require your explicit approval whenever Google support and engineering need to access your customer content. To get more information about ProjectSettings, see:

Example Usage

Project Access Approval Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const projectAccessApproval = new gcp.projects.AccessApprovalSettings("project_access_approval", {
    projectId: "my-project-name",
    notificationEmails: [
        "testuser@example.com",
        "example.user@example.com",
    ],
    enrolledServices: [{
        cloudProduct: "all",
        enrollmentLevel: "BLOCK_ALL",
    }],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
project_access_approval = gcp.projects.AccessApprovalSettings("project_access_approval",
    project_id="my-project-name",
    notification_emails=[
        "testuser@example.com",
        "example.user@example.com",
    ],
    enrolled_services=[{
        "cloud_product": "all",
        "enrollment_level": "BLOCK_ALL",
    }])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var projectAccessApproval = new Gcp.Projects.AccessApprovalSettings("project_access_approval", new()
    {
        ProjectId = "my-project-name",
        NotificationEmails = new[]
        {
            "testuser@example.com",
            "example.user@example.com",
        },
        EnrolledServices = new[]
        {
            new Gcp.Projects.Inputs.AccessApprovalSettingsEnrolledServiceArgs
            {
                CloudProduct = "all",
                EnrollmentLevel = "BLOCK_ALL",
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := projects.NewAccessApprovalSettings(ctx, "project_access_approval", &projects.AccessApprovalSettingsArgs{
			ProjectId: pulumi.String("my-project-name"),
			NotificationEmails: pulumi.StringArray{
				pulumi.String("testuser@example.com"),
				pulumi.String("example.user@example.com"),
			},
			EnrolledServices: projects.AccessApprovalSettingsEnrolledServiceArray{
				&projects.AccessApprovalSettingsEnrolledServiceArgs{
					CloudProduct:    pulumi.String("all"),
					EnrollmentLevel: pulumi.String("BLOCK_ALL"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.AccessApprovalSettings;
import com.pulumi.gcp.projects.AccessApprovalSettingsArgs;
import com.pulumi.gcp.projects.inputs.AccessApprovalSettingsEnrolledServiceArgs;
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 projectAccessApproval = new AccessApprovalSettings("projectAccessApproval", AccessApprovalSettingsArgs.builder()
            .projectId("my-project-name")
            .notificationEmails(
                "testuser@example.com",
                "example.user@example.com")
            .enrolledServices(AccessApprovalSettingsEnrolledServiceArgs.builder()
                .cloudProduct("all")
                .enrollmentLevel("BLOCK_ALL")
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  projectAccessApproval:
    type: gcp:projects:AccessApprovalSettings
    name: project_access_approval
    properties:
      projectId: my-project-name
      notificationEmails:
        - testuser@example.com
        - example.user@example.com
      enrolledServices:
        - cloudProduct: all
          enrollmentLevel: BLOCK_ALL
Content copied to clipboard

Project Access Approval Active Key Version

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const keyRing = new gcp.kms.KeyRing("key_ring", {
    name: "key-ring",
    location: "global",
    project: "my-project-name",
});
const cryptoKey = new gcp.kms.CryptoKey("crypto_key", {
    name: "crypto-key",
    keyRing: keyRing.id,
    purpose: "ASYMMETRIC_SIGN",
    versionTemplate: {
        algorithm: "EC_SIGN_P384_SHA384",
    },
});
const serviceAccount = gcp.accessapproval.getProjectServiceAccount({
    projectId: "my-project-name",
});
const iam = new gcp.kms.CryptoKeyIAMMember("iam", {
    cryptoKeyId: cryptoKey.id,
    role: "roles/cloudkms.signerVerifier",
    member: serviceAccount.then(serviceAccount => `serviceAccount:${serviceAccount.accountEmail}`),
});
const cryptoKeyVersion = gcp.kms.getKMSCryptoKeyVersionOutput({
    cryptoKey: cryptoKey.id,
});
const projectAccessApproval = new gcp.projects.AccessApprovalSettings("project_access_approval", {
    projectId: "my-project-name",
    activeKeyVersion: cryptoKeyVersion.apply(cryptoKeyVersion => cryptoKeyVersion.name),
    enrolledServices: [{
        cloudProduct: "all",
    }],
}, {
    dependsOn: [iam],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
key_ring = gcp.kms.KeyRing("key_ring",
    name="key-ring",
    location="global",
    project="my-project-name")
crypto_key = gcp.kms.CryptoKey("crypto_key",
    name="crypto-key",
    key_ring=key_ring.id,
    purpose="ASYMMETRIC_SIGN",
    version_template={
        "algorithm": "EC_SIGN_P384_SHA384",
    })
service_account = gcp.accessapproval.get_project_service_account(project_id="my-project-name")
iam = gcp.kms.CryptoKeyIAMMember("iam",
    crypto_key_id=crypto_key.id,
    role="roles/cloudkms.signerVerifier",
    member=f"serviceAccount:{service_account.account_email}")
crypto_key_version = gcp.kms.get_kms_crypto_key_version_output(crypto_key=crypto_key.id)
project_access_approval = gcp.projects.AccessApprovalSettings("project_access_approval",
    project_id="my-project-name",
    active_key_version=crypto_key_version.name,
    enrolled_services=[{
        "cloud_product": "all",
    }],
    opts = pulumi.ResourceOptions(depends_on=[iam]))
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var keyRing = new Gcp.Kms.KeyRing("key_ring", new()
    {
        Name = "key-ring",
        Location = "global",
        Project = "my-project-name",
    });
    var cryptoKey = new Gcp.Kms.CryptoKey("crypto_key", new()
    {
        Name = "crypto-key",
        KeyRing = keyRing.Id,
        Purpose = "ASYMMETRIC_SIGN",
        VersionTemplate = new Gcp.Kms.Inputs.CryptoKeyVersionTemplateArgs
        {
            Algorithm = "EC_SIGN_P384_SHA384",
        },
    });
    var serviceAccount = Gcp.AccessApproval.GetProjectServiceAccount.Invoke(new()
    {
        ProjectId = "my-project-name",
    });
    var iam = new Gcp.Kms.CryptoKeyIAMMember("iam", new()
    {
        CryptoKeyId = cryptoKey.Id,
        Role = "roles/cloudkms.signerVerifier",
        Member = $"serviceAccount:{serviceAccount.Apply(getProjectServiceAccountResult => getProjectServiceAccountResult.AccountEmail)}",
    });
    var cryptoKeyVersion = Gcp.Kms.GetKMSCryptoKeyVersion.Invoke(new()
    {
        CryptoKey = cryptoKey.Id,
    });
    var projectAccessApproval = new Gcp.Projects.AccessApprovalSettings("project_access_approval", new()
    {
        ProjectId = "my-project-name",
        ActiveKeyVersion = cryptoKeyVersion.Apply(getKMSCryptoKeyVersionResult => getKMSCryptoKeyVersionResult.Name),
        EnrolledServices = new[]
        {
            new Gcp.Projects.Inputs.AccessApprovalSettingsEnrolledServiceArgs
            {
                CloudProduct = "all",
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            iam,
        },
    });
});
Content copied to clipboard
package main
import (
	"fmt"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/accessapproval"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		keyRing, err := kms.NewKeyRing(ctx, "key_ring", &kms.KeyRingArgs{
			Name:     pulumi.String("key-ring"),
			Location: pulumi.String("global"),
			Project:  pulumi.String("my-project-name"),
		})
		if err != nil {
			return err
		}
		cryptoKey, err := kms.NewCryptoKey(ctx, "crypto_key", &kms.CryptoKeyArgs{
			Name:    pulumi.String("crypto-key"),
			KeyRing: keyRing.ID(),
			Purpose: pulumi.String("ASYMMETRIC_SIGN"),
			VersionTemplate: &kms.CryptoKeyVersionTemplateArgs{
				Algorithm: pulumi.String("EC_SIGN_P384_SHA384"),
			},
		})
		if err != nil {
			return err
		}
		serviceAccount, err := accessapproval.GetProjectServiceAccount(ctx, &accessapproval.GetProjectServiceAccountArgs{
			ProjectId: "my-project-name",
		}, nil)
		if err != nil {
			return err
		}
		iam, err := kms.NewCryptoKeyIAMMember(ctx, "iam", &kms.CryptoKeyIAMMemberArgs{
			CryptoKeyId: cryptoKey.ID(),
			Role:        pulumi.String("roles/cloudkms.signerVerifier"),
			Member:      pulumi.Sprintf("serviceAccount:%v", serviceAccount.AccountEmail),
		})
		if err != nil {
			return err
		}
		cryptoKeyVersion := kms.GetKMSCryptoKeyVersionOutput(ctx, kms.GetKMSCryptoKeyVersionOutputArgs{
			CryptoKey: cryptoKey.ID(),
		}, nil)
		_, err = projects.NewAccessApprovalSettings(ctx, "project_access_approval", &projects.AccessApprovalSettingsArgs{
			ProjectId: pulumi.String("my-project-name"),
			ActiveKeyVersion: pulumi.String(cryptoKeyVersion.ApplyT(func(cryptoKeyVersion kms.GetKMSCryptoKeyVersionResult) (*string, error) {
				return &cryptoKeyVersion.Name, nil
			}).(pulumi.StringPtrOutput)),
			EnrolledServices: projects.AccessApprovalSettingsEnrolledServiceArray{
				&projects.AccessApprovalSettingsEnrolledServiceArgs{
					CloudProduct: pulumi.String("all"),
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			iam,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.kms.KeyRing;
import com.pulumi.gcp.kms.KeyRingArgs;
import com.pulumi.gcp.kms.CryptoKey;
import com.pulumi.gcp.kms.CryptoKeyArgs;
import com.pulumi.gcp.kms.inputs.CryptoKeyVersionTemplateArgs;
import com.pulumi.gcp.accessapproval.AccessapprovalFunctions;
import com.pulumi.gcp.accessapproval.inputs.GetProjectServiceAccountArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
import com.pulumi.gcp.kms.KmsFunctions;
import com.pulumi.gcp.kms.inputs.GetKMSCryptoKeyVersionArgs;
import com.pulumi.gcp.projects.AccessApprovalSettings;
import com.pulumi.gcp.projects.AccessApprovalSettingsArgs;
import com.pulumi.gcp.projects.inputs.AccessApprovalSettingsEnrolledServiceArgs;
import com.pulumi.resources.CustomResourceOptions;
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 keyRing = new KeyRing("keyRing", KeyRingArgs.builder()
            .name("key-ring")
            .location("global")
            .project("my-project-name")
            .build());
        var cryptoKey = new CryptoKey("cryptoKey", CryptoKeyArgs.builder()
            .name("crypto-key")
            .keyRing(keyRing.id())
            .purpose("ASYMMETRIC_SIGN")
            .versionTemplate(CryptoKeyVersionTemplateArgs.builder()
                .algorithm("EC_SIGN_P384_SHA384")
                .build())
            .build());
        final var serviceAccount = AccessapprovalFunctions.getProjectServiceAccount(GetProjectServiceAccountArgs.builder()
            .projectId("my-project-name")
            .build());
        var iam = new CryptoKeyIAMMember("iam", CryptoKeyIAMMemberArgs.builder()
            .cryptoKeyId(cryptoKey.id())
            .role("roles/cloudkms.signerVerifier")
            .member(String.format("serviceAccount:%s", serviceAccount.applyValue(getProjectServiceAccountResult -> getProjectServiceAccountResult.accountEmail())))
            .build());
        final var cryptoKeyVersion = KmsFunctions.getKMSCryptoKeyVersion(GetKMSCryptoKeyVersionArgs.builder()
            .cryptoKey(cryptoKey.id())
            .build());
        var projectAccessApproval = new AccessApprovalSettings("projectAccessApproval", AccessApprovalSettingsArgs.builder()
            .projectId("my-project-name")
            .activeKeyVersion(cryptoKeyVersion.applyValue(getKMSCryptoKeyVersionResult -> getKMSCryptoKeyVersionResult).applyValue(cryptoKeyVersion -> cryptoKeyVersion.applyValue(getKMSCryptoKeyVersionResult -> getKMSCryptoKeyVersionResult.name())))
            .enrolledServices(AccessApprovalSettingsEnrolledServiceArgs.builder()
                .cloudProduct("all")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(iam)
                .build());
    }
}
Content copied to clipboard
resources:
  keyRing:
    type: gcp:kms:KeyRing
    name: key_ring
    properties:
      name: key-ring
      location: global
      project: my-project-name
  cryptoKey:
    type: gcp:kms:CryptoKey
    name: crypto_key
    properties:
      name: crypto-key
      keyRing: ${keyRing.id}
      purpose: ASYMMETRIC_SIGN
      versionTemplate:
        algorithm: EC_SIGN_P384_SHA384
  iam:
    type: gcp:kms:CryptoKeyIAMMember
    properties:
      cryptoKeyId: ${cryptoKey.id}
      role: roles/cloudkms.signerVerifier
      member: serviceAccount:${serviceAccount.accountEmail}
  projectAccessApproval:
    type: gcp:projects:AccessApprovalSettings
    name: project_access_approval
    properties:
      projectId: my-project-name
      activeKeyVersion: ${cryptoKeyVersion.name}
      enrolledServices:
        - cloudProduct: all
    options:
      dependson:
        - ${iam}
variables:
  serviceAccount:
    fn::invoke:
      Function: gcp:accessapproval:getProjectServiceAccount
      Arguments:
        projectId: my-project-name
  cryptoKeyVersion:
    fn::invoke:
      Function: gcp:kms:getKMSCryptoKeyVersion
      Arguments:
        cryptoKey: ${cryptoKey.id}
Content copied to clipboard

Import

ProjectSettings can be imported using any of these accepted formats:

  • projects/{{project_id}}/accessApprovalSettings

  • {{project_id}} When using the pulumi import command, ProjectSettings can be imported using one of the formats above. For example:

$ pulumi import gcp:projects/accessApprovalSettings:AccessApprovalSettings default projects/{{project_id}}/accessApprovalSettings
Content copied to clipboard
$ pulumi import gcp:projects/accessApprovalSettings:AccessApprovalSettings default {{project_id}}
Content copied to clipboard

Properties

Link copied to clipboard
val activeKeyVersion: Output<String>?

The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of the resource, and new non-empty values may not be set.

Link copied to clipboard
val ancestorHasActiveKeyVersion: Output<Boolean>

If the field is true, that indicates that an ancestor of this Project has set active_key_version.

Link copied to clipboard
val enrolledAncestor: Output<Boolean>

If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project.

Link copied to clipboard
val enrolledServices: Output<List<AccessApprovalSettingsEnrolledService>>

A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. Enrollment can only be done on an all or nothing basis. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. Structure is documented below.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val invalidKeyVersion: Output<Boolean>

If the field is true, that indicates that there is some configuration issue with the active_key_version configured on this Project (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down.

Link copied to clipboard
val name: Output<String>

The resource name of the settings. Format is "projects/{project_id}/accessApprovalSettings"

Link copied to clipboard
val notificationEmails: Output<List<String>>

A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.

Link copied to clipboard
val project: Output<String>?

Project id.

Link copied to clipboard
val projectId: Output<String>

ID of the project of the access approval settings.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>