Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. Gate

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

pulumiservice.api.Gate

pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

    Creates a new change gate for an entity in the organization. Change gates enforce approval workflows by requiring one or more approvals before infrastructure changes can be applied to the protected resource.

    Create Gate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Gate(name: string, args: GateArgs, opts?: CustomResourceOptions);
    @overload
def Gate(resource_name: str,
         args: GateArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Gate(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         enabled: Optional[bool] = None,
         name: Optional[str] = None,
         org_name: Optional[str] = None,
         rule: Optional[Any] = None,
         target: Optional[Any] = None,
         gate_id: Optional[str] = None)
    func NewGate(ctx *Context, name string, args GateArgs, opts ...ResourceOption) (*Gate, error)
    public Gate(string name, GateArgs args, CustomResourceOptions? opts = null)
    public Gate(String name, GateArgs args)
public Gate(String name, GateArgs args, CustomResourceOptions options)

    type: pulumiservice:api:Gate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "pulumiservice_api_gate" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GateArgs
    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 GateArgs
    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 GateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GateArgs
    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 gateResource = new PulumiService.Api.Gate("gateResource", new()
{
    Enabled = false,
    Name = "string",
    OrgName = "string",
    Rule = "any",
    Target = "any",
    GateID = "string",
});

    example, err := api.NewGate(ctx, "gateResource", &api.GateArgs{
	Enabled: pulumi.Bool(false),
	Name:    pulumi.String("string"),
	OrgName: pulumi.String("string"),
	Rule:    pulumi.Any("any"),
	Target:  pulumi.Any("any"),
	GateID:  pulumi.String("string"),
})

    resource "pulumiservice_api_gate" "gateResource" {
  enabled  = false
  name     = "string"
  org_name = "string"
  rule     = "any"
  target   = "any"
  gate_id  = "string"
}

    var gateResource = new Gate("gateResource", GateArgs.builder()
    .enabled(false)
    .name("string")
    .orgName("string")
    .rule("any")
    .target("any")
    .gateID("string")
    .build());

    gate_resource = pulumiservice.api.Gate("gateResource",
    enabled=False,
    name="string",
    org_name="string",
    rule="any",
    target="any",
    gate_id="string")

    const gateResource = new pulumiservice.api.Gate("gateResource", {
    enabled: false,
    name: "string",
    orgName: "string",
    rule: "any",
    target: "any",
    gateID: "string",
});

    type: pulumiservice:api:Gate
properties:
    enabled: false
    gateID: string
    name: string
    orgName: string
    rule: any
    target: any

    Gate 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 Gate resource accepts the following input properties:

    Enabled bool
    Whether the change gate is enabled
    Name string
    Name of the change gate
    OrgName string
    The organization name
    Rule object
    Rule configuration for the gate
    Target object
    Target configuration for the gate
    GateID string
    The change gate identifier
    Enabled bool
    Whether the change gate is enabled
    Name string
    Name of the change gate
    OrgName string
    The organization name
    Rule interface{}
    Rule configuration for the gate
    Target interface{}
    Target configuration for the gate
    GateID string
    The change gate identifier
    enabled bool
    Whether the change gate is enabled
    name string
    Name of the change gate
    org_name string
    The organization name
    rule any
    Rule configuration for the gate
    target any
    Target configuration for the gate
    gate_id string
    The change gate identifier
    enabled Boolean
    Whether the change gate is enabled
    name String
    Name of the change gate
    orgName String
    The organization name
    rule Object
    Rule configuration for the gate
    target Object
    Target configuration for the gate
    gateID String
    The change gate identifier
    enabled boolean
    Whether the change gate is enabled
    name string
    Name of the change gate
    orgName string
    The organization name
    rule any
    Rule configuration for the gate
    target any
    Target configuration for the gate
    gateID string
    The change gate identifier
    enabled bool
    Whether the change gate is enabled
    name str
    Name of the change gate
    org_name str
    The organization name
    rule Any
    Rule configuration for the gate
    target Any
    Target configuration for the gate
    gate_id str
    The change gate identifier
    enabled Boolean
    Whether the change gate is enabled
    name String
    Name of the change gate
    orgName String
    The organization name
    rule Any
    Rule configuration for the gate
    target Any
    Target configuration for the gate
    gateID String
    The change gate identifier

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Gate resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-pulumiservice

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial