Module runtimeconfig

This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Config
ConfigIamBinding
ConfigIamMember
ConfigIamPolicy
Variable

Resources

Resource Config

class Config extends CustomResource

Manages a RuntimeConfig resource in Google Cloud. For more information, see the official documentation, or the JSON API.

Example Usage

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

const myRuntimeConfig = new gcp.runtimeconfig.Config("my-runtime-config", {
    description: "Runtime configuration values for my service",
});

constructor

new Config(name: string, args?: ConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a Config resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigState, opts?: pulumi.CustomResourceOptions): Config

Get an existing Config resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Config

Returns true if the given object is an instance of Config. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The description to associate with the runtime config.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the runtime config.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ConfigIamBinding

class ConfigIamBinding extends CustomResource

Three different resources help you manage your IAM policy for Runtime Configurator Config. Each of these resources serves a different use case:

gcp.runtimeconfig.ConfigIamPolicy: Authoritative. Sets the IAM policy for the config and replaces any existing policy already attached.
gcp.runtimeconfig.ConfigIamBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the config are preserved.
gcp.runtimeconfig.ConfigIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the config are preserved.

Note: gcp.runtimeconfig.ConfigIamPolicy cannot be used in conjunction with gcp.runtimeconfig.ConfigIamBinding and gcp.runtimeconfig.ConfigIamMember or they will fight over what your policy should be.
Note: gcp.runtimeconfig.ConfigIamBinding resources can be used in conjunction with gcp.runtimeconfig.ConfigIamMember resources only if they do not grant privilege to the same role.

google_runtimeconfig_config_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.runtimeconfig.ConfigIamPolicy("policy", {
    project: google_runtimeconfig_config.config.project,
    config: google_runtimeconfig_config.config.name,
    policyData: admin.then(admin => admin.policyData),
});

google_runtimeconfig_config_iam_binding

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

const binding = new gcp.runtimeconfig.ConfigIamBinding("binding", {
    project: google_runtimeconfig_config.config.project,
    config: google_runtimeconfig_config.config.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

google_runtimeconfig_config_iam_member

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

const member = new gcp.runtimeconfig.ConfigIamMember("member", {
    project: google_runtimeconfig_config.config.project,
    config: google_runtimeconfig_config.config.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

constructor

new ConfigIamBinding(name: string, args: ConfigIamBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a ConfigIamBinding resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigIamBindingState, opts?: pulumi.CustomResourceOptions): ConfigIamBinding

Get an existing ConfigIamBinding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ConfigIamBinding

Returns true if the given object is an instance of ConfigIamBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<ConfigIamBindingCondition | undefined>;

property config

public config: pulumi.Output<string>;

Used to find the parent resource to bind the IAM policy to

property etag

public etag: pulumi.Output<string>;

(Computed) The etag of the IAM policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property members

public members: pulumi.Output<string[]>;

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

property role

public role: pulumi.Output<string>;

The role that should be applied. Only one gcp.runtimeconfig.ConfigIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ConfigIamMember

class ConfigIamMember extends CustomResource

Three different resources help you manage your IAM policy for Runtime Configurator Config. Each of these resources serves a different use case:

gcp.runtimeconfig.ConfigIamPolicy: Authoritative. Sets the IAM policy for the config and replaces any existing policy already attached.
gcp.runtimeconfig.ConfigIamBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the config are preserved.
gcp.runtimeconfig.ConfigIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the config are preserved.

Note: gcp.runtimeconfig.ConfigIamPolicy cannot be used in conjunction with gcp.runtimeconfig.ConfigIamBinding and gcp.runtimeconfig.ConfigIamMember or they will fight over what your policy should be.
Note: gcp.runtimeconfig.ConfigIamBinding resources can be used in conjunction with gcp.runtimeconfig.ConfigIamMember resources only if they do not grant privilege to the same role.

google_runtimeconfig_config_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.runtimeconfig.ConfigIamPolicy("policy", {
    project: google_runtimeconfig_config.config.project,
    config: google_runtimeconfig_config.config.name,
    policyData: admin.then(admin => admin.policyData),
});

google_runtimeconfig_config_iam_binding

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

const binding = new gcp.runtimeconfig.ConfigIamBinding("binding", {
    project: google_runtimeconfig_config.config.project,
    config: google_runtimeconfig_config.config.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

google_runtimeconfig_config_iam_member

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

const member = new gcp.runtimeconfig.ConfigIamMember("member", {
    project: google_runtimeconfig_config.config.project,
    config: google_runtimeconfig_config.config.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

constructor

new ConfigIamMember(name: string, args: ConfigIamMemberArgs, opts?: pulumi.CustomResourceOptions)

Create a ConfigIamMember resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigIamMemberState, opts?: pulumi.CustomResourceOptions): ConfigIamMember

Get an existing ConfigIamMember resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ConfigIamMember

Returns true if the given object is an instance of ConfigIamMember. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<ConfigIamMemberCondition | undefined>;

property config

public config: pulumi.Output<string>;

Used to find the parent resource to bind the IAM policy to

property etag

public etag: pulumi.Output<string>;

(Computed) The etag of the IAM policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property member

public member: pulumi.Output<string>;

property project

public project: pulumi.Output<string>;

property role

public role: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ConfigIamPolicy

class ConfigIamPolicy extends CustomResource

Three different resources help you manage your IAM policy for Runtime Configurator Config. Each of these resources serves a different use case:

gcp.runtimeconfig.ConfigIamPolicy: Authoritative. Sets the IAM policy for the config and replaces any existing policy already attached.
gcp.runtimeconfig.ConfigIamBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the config are preserved.
gcp.runtimeconfig.ConfigIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the config are preserved.

Note: gcp.runtimeconfig.ConfigIamPolicy cannot be used in conjunction with gcp.runtimeconfig.ConfigIamBinding and gcp.runtimeconfig.ConfigIamMember or they will fight over what your policy should be.
Note: gcp.runtimeconfig.ConfigIamBinding resources can be used in conjunction with gcp.runtimeconfig.ConfigIamMember resources only if they do not grant privilege to the same role.

google_runtimeconfig_config_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.runtimeconfig.ConfigIamPolicy("policy", {
    project: google_runtimeconfig_config.config.project,
    config: google_runtimeconfig_config.config.name,
    policyData: admin.then(admin => admin.policyData),
});

google_runtimeconfig_config_iam_binding

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

const binding = new gcp.runtimeconfig.ConfigIamBinding("binding", {
    project: google_runtimeconfig_config.config.project,
    config: google_runtimeconfig_config.config.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

google_runtimeconfig_config_iam_member

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

const member = new gcp.runtimeconfig.ConfigIamMember("member", {
    project: google_runtimeconfig_config.config.project,
    config: google_runtimeconfig_config.config.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

constructor

new ConfigIamPolicy(name: string, args: ConfigIamPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a ConfigIamPolicy resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigIamPolicyState, opts?: pulumi.CustomResourceOptions): ConfigIamPolicy

Get an existing ConfigIamPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ConfigIamPolicy

Returns true if the given object is an instance of ConfigIamPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property config

public config: pulumi.Output<string>;

Used to find the parent resource to bind the IAM policy to

property etag

public etag: pulumi.Output<string>;

(Computed) The etag of the IAM policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property policyData

public policyData: pulumi.Output<string>;

The policy data generated by a gcp.organizations.getIAMPolicy data source.

property project

public project: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Variable

class Variable extends CustomResource

Manages a RuntimeConfig variable in Google Cloud. For more information, see the official documentation, or the JSON API.

constructor

new Variable(name: string, args: VariableArgs, opts?: pulumi.CustomResourceOptions)

Create a Variable resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VariableState, opts?: pulumi.CustomResourceOptions): Variable

Get an existing Variable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Variable

Returns true if the given object is an instance of Variable. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the variable to manage. Note that variable names can be hierarchical using slashes (e.g. “prod-variables/hostname”).

property parent

public parent: pulumi.Output<string>;

The name of the RuntimeConfig resource containing this variable.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property text

public text: pulumi.Output<string | undefined>;

or value - (Required) The content to associate with the variable. Exactly one of text or variable must be specified. If text is specified, it must be a valid UTF-8 string and less than 4096 bytes in length. If value is specified, it must be base64 encoded and less than 4096 bytes in length.

property updateTime

public updateTime: pulumi.Output<string>;

(Computed) The timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds, representing when the variable was last updated. Example: “2016-10-09T12:33:37.578138407Z”.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<string | undefined>;

Others

interface ConfigArgs

interface ConfigArgs

The set of arguments for constructing a Config resource.

property description

description?: pulumi.Input<string>;

The description to associate with the runtime config.

property name

name?: pulumi.Input<string>;

The name of the runtime config.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface ConfigIamBindingArgs

interface ConfigIamBindingArgs

The set of arguments for constructing a ConfigIamBinding resource.

property condition

condition?: pulumi.Input<ConfigIamBindingCondition>;

property config

config: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property members

members: pulumi.Input<pulumi.Input<string>[]>;

property project

project?: pulumi.Input<string>;

property role

role: pulumi.Input<string>;

interface ConfigIamBindingState

interface ConfigIamBindingState

Input properties used for looking up and filtering ConfigIamBinding resources.

property condition

condition?: pulumi.Input<ConfigIamBindingCondition>;

property config

config?: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property etag

etag?: pulumi.Input<string>;

(Computed) The etag of the IAM policy.

property members

members?: pulumi.Input<pulumi.Input<string>[]>;

property project

project?: pulumi.Input<string>;

property role

role?: pulumi.Input<string>;

interface ConfigIamMemberArgs

interface ConfigIamMemberArgs

The set of arguments for constructing a ConfigIamMember resource.

property condition

condition?: pulumi.Input<ConfigIamMemberCondition>;

property config

config: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property member

member: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

property role

role: pulumi.Input<string>;

interface ConfigIamMemberState

interface ConfigIamMemberState

Input properties used for looking up and filtering ConfigIamMember resources.

property condition

condition?: pulumi.Input<ConfigIamMemberCondition>;

property config

config?: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property etag

etag?: pulumi.Input<string>;

(Computed) The etag of the IAM policy.

property member

member?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

property role

role?: pulumi.Input<string>;

interface ConfigIamPolicyArgs

interface ConfigIamPolicyArgs

The set of arguments for constructing a ConfigIamPolicy resource.

property config

config: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property policyData

policyData: pulumi.Input<string>;

The policy data generated by a gcp.organizations.getIAMPolicy data source.

property project

project?: pulumi.Input<string>;

interface ConfigIamPolicyState

interface ConfigIamPolicyState

Input properties used for looking up and filtering ConfigIamPolicy resources.

property config

config?: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property etag

etag?: pulumi.Input<string>;

(Computed) The etag of the IAM policy.

property policyData

policyData?: pulumi.Input<string>;

The policy data generated by a gcp.organizations.getIAMPolicy data source.

property project

project?: pulumi.Input<string>;

interface ConfigState

interface ConfigState

Input properties used for looking up and filtering Config resources.

property description

description?: pulumi.Input<string>;

The description to associate with the runtime config.

property name

name?: pulumi.Input<string>;

The name of the runtime config.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface VariableArgs

interface VariableArgs

The set of arguments for constructing a Variable resource.

property name

name?: pulumi.Input<string>;

The name of the variable to manage. Note that variable names can be hierarchical using slashes (e.g. “prod-variables/hostname”).

property parent

parent: pulumi.Input<string>;

The name of the RuntimeConfig resource containing this variable.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property text

text?: pulumi.Input<string>;

property value

value?: pulumi.Input<string>;

interface VariableState

interface VariableState

Input properties used for looking up and filtering Variable resources.

property name

name?: pulumi.Input<string>;

The name of the variable to manage. Note that variable names can be hierarchical using slashes (e.g. “prod-variables/hostname”).

property parent

parent?: pulumi.Input<string>;

The name of the RuntimeConfig resource containing this variable.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property text

text?: pulumi.Input<string>;

property updateTime

updateTime?: pulumi.Input<string>;

(Computed) The timestamp in RFC3339 UTC “Zulu” format, accurate to nanoseconds, representing when the variable was last updated. Example: “2016-10-09T12:33:37.578138407Z”.

property value

value?: pulumi.Input<string>;

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module runtimeconfig

Resources

Others

Resources

Example Usage

google_runtimeconfig_config_iam_policy

google_runtimeconfig_config_iam_binding

google_runtimeconfig_config_iam_member

google_runtimeconfig_config_iam_policy

google_runtimeconfig_config_iam_binding

google_runtimeconfig_config_iam_member

google_runtimeconfig_config_iam_policy

google_runtimeconfig_config_iam_binding

google_runtimeconfig_config_iam_member

Others