Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Temporalcloud Provider
  3. API Docs
  4. ConnectivityRule
Temporal Cloud 0.9.0 published on Wednesday, Jul 16, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

temporalcloud.ConnectivityRule

Explore with Pulumi AI

temporalcloud logo
Temporal Cloud 0.9.0 published on Wednesday, Jul 16, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

    Provisions a Temporal Cloud Connectivity Rule.

    Create ConnectivityRule Resource

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

    Constructor syntax

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

@overload
def ConnectivityRule(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     connectivity_type: Optional[str] = None,
                     connection_id: Optional[str] = None,
                     gcp_project_id: Optional[str] = None,
                     region: Optional[str] = None,
                     timeouts: Optional[ConnectivityRuleTimeoutsArgs] = None)
    func NewConnectivityRule(ctx *Context, name string, args ConnectivityRuleArgs, opts ...ResourceOption) (*ConnectivityRule, error)
    public ConnectivityRule(string name, ConnectivityRuleArgs args, CustomResourceOptions? opts = null)
    public ConnectivityRule(String name, ConnectivityRuleArgs args)
public ConnectivityRule(String name, ConnectivityRuleArgs args, CustomResourceOptions options)

    type: temporalcloud:ConnectivityRule
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 ConnectivityRuleArgs
    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 ConnectivityRuleArgs
    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 ConnectivityRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectivityRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectivityRuleArgs
    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 connectivityRuleResource = new Temporalcloud.ConnectivityRule("connectivityRuleResource", new()
{
    ConnectivityType = "string",
    ConnectionId = "string",
    GcpProjectId = "string",
    Region = "string",
    Timeouts = new Temporalcloud.Inputs.ConnectivityRuleTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := temporalcloud.NewConnectivityRule(ctx, "connectivityRuleResource", &temporalcloud.ConnectivityRuleArgs{
	ConnectivityType: pulumi.String("string"),
	ConnectionId:     pulumi.String("string"),
	GcpProjectId:     pulumi.String("string"),
	Region:           pulumi.String("string"),
	Timeouts: &temporalcloud.ConnectivityRuleTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    var connectivityRuleResource = new ConnectivityRule("connectivityRuleResource", ConnectivityRuleArgs.builder()
    .connectivityType("string")
    .connectionId("string")
    .gcpProjectId("string")
    .region("string")
    .timeouts(ConnectivityRuleTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    connectivity_rule_resource = temporalcloud.ConnectivityRule("connectivityRuleResource",
    connectivity_type="string",
    connection_id="string",
    gcp_project_id="string",
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const connectivityRuleResource = new temporalcloud.ConnectivityRule("connectivityRuleResource", {
    connectivityType: "string",
    connectionId: "string",
    gcpProjectId: "string",
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: temporalcloud:ConnectivityRule
properties:
    connectionId: string
    connectivityType: string
    gcpProjectId: string
    region: string
    timeouts:
        create: string
        delete: string

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

    ConnectivityType string
    The type of connectivity. Must be one of 'public' or 'private'.
    ConnectionId string
    The connection ID of the private connection.
    GcpProjectId string
    The GCP project ID. Required when cloud_provider is 'gcp'.
    Region string
    The region of the connection. Example: 'aws-us-west-2'.
    Timeouts ConnectivityRuleTimeouts
    ConnectivityType string
    The type of connectivity. Must be one of 'public' or 'private'.
    ConnectionId string
    The connection ID of the private connection.
    GcpProjectId string
    The GCP project ID. Required when cloud_provider is 'gcp'.
    Region string
    The region of the connection. Example: 'aws-us-west-2'.
    Timeouts ConnectivityRuleTimeoutsArgs
    connectivityType String
    The type of connectivity. Must be one of 'public' or 'private'.
    connectionId String
    The connection ID of the private connection.
    gcpProjectId String
    The GCP project ID. Required when cloud_provider is 'gcp'.
    region String
    The region of the connection. Example: 'aws-us-west-2'.
    timeouts ConnectivityRuleTimeouts
    connectivityType string
    The type of connectivity. Must be one of 'public' or 'private'.
    connectionId string
    The connection ID of the private connection.
    gcpProjectId string
    The GCP project ID. Required when cloud_provider is 'gcp'.
    region string
    The region of the connection. Example: 'aws-us-west-2'.
    timeouts ConnectivityRuleTimeouts
    connectivity_type str
    The type of connectivity. Must be one of 'public' or 'private'.
    connection_id str
    The connection ID of the private connection.
    gcp_project_id str
    The GCP project ID. Required when cloud_provider is 'gcp'.
    region str
    The region of the connection. Example: 'aws-us-west-2'.
    timeouts ConnectivityRuleTimeoutsArgs
    connectivityType String
    The type of connectivity. Must be one of 'public' or 'private'.
    connectionId String
    The connection ID of the private connection.
    gcpProjectId String
    The GCP project ID. Required when cloud_provider is 'gcp'.
    region String
    The region of the connection. Example: 'aws-us-west-2'.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConnectivityRule 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ConnectivityRule Resource

    Get an existing ConnectivityRule 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?: ConnectivityRuleState, opts?: CustomResourceOptions): ConnectivityRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_id: Optional[str] = None,
        connectivity_type: Optional[str] = None,
        gcp_project_id: Optional[str] = None,
        region: Optional[str] = None,
        timeouts: Optional[ConnectivityRuleTimeoutsArgs] = None) -> ConnectivityRule
    func GetConnectivityRule(ctx *Context, name string, id IDInput, state *ConnectivityRuleState, opts ...ResourceOption) (*ConnectivityRule, error)
    public static ConnectivityRule Get(string name, Input<string> id, ConnectivityRuleState? state, CustomResourceOptions? opts = null)
    public static ConnectivityRule get(String name, Output<String> id, ConnectivityRuleState state, CustomResourceOptions options)
    resources:  _:    type: temporalcloud:ConnectivityRule    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.
    The following state arguments are supported:
    ConnectionId string
    The connection ID of the private connection.
    ConnectivityType string
    The type of connectivity. Must be one of 'public' or 'private'.
    GcpProjectId string
    The GCP project ID. Required when cloud_provider is 'gcp'.
    Region string
    The region of the connection. Example: 'aws-us-west-2'.
    Timeouts ConnectivityRuleTimeouts
    ConnectionId string
    The connection ID of the private connection.
    ConnectivityType string
    The type of connectivity. Must be one of 'public' or 'private'.
    GcpProjectId string
    The GCP project ID. Required when cloud_provider is 'gcp'.
    Region string
    The region of the connection. Example: 'aws-us-west-2'.
    Timeouts ConnectivityRuleTimeoutsArgs
    connectionId String
    The connection ID of the private connection.
    connectivityType String
    The type of connectivity. Must be one of 'public' or 'private'.
    gcpProjectId String
    The GCP project ID. Required when cloud_provider is 'gcp'.
    region String
    The region of the connection. Example: 'aws-us-west-2'.
    timeouts ConnectivityRuleTimeouts
    connectionId string
    The connection ID of the private connection.
    connectivityType string
    The type of connectivity. Must be one of 'public' or 'private'.
    gcpProjectId string
    The GCP project ID. Required when cloud_provider is 'gcp'.
    region string
    The region of the connection. Example: 'aws-us-west-2'.
    timeouts ConnectivityRuleTimeouts
    connection_id str
    The connection ID of the private connection.
    connectivity_type str
    The type of connectivity. Must be one of 'public' or 'private'.
    gcp_project_id str
    The GCP project ID. Required when cloud_provider is 'gcp'.
    region str
    The region of the connection. Example: 'aws-us-west-2'.
    timeouts ConnectivityRuleTimeoutsArgs
    connectionId String
    The connection ID of the private connection.
    connectivityType String
    The type of connectivity. Must be one of 'public' or 'private'.
    gcpProjectId String
    The GCP project ID. Required when cloud_provider is 'gcp'.
    region String
    The region of the connection. Example: 'aws-us-west-2'.
    timeouts Property Map

    Supporting Types

    ConnectivityRuleTimeouts, ConnectivityRuleTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Package Details

    Repository
    temporalcloud temporalio/terraform-provider-temporalcloud
    License
    Notes
    This Pulumi package is based on the temporalcloud Terraform Provider.
    temporalcloud logo
    Temporal Cloud 0.9.0 published on Wednesday, Jul 16, 2025 by temporalio
    temporalio/terraform-provider-temporalcloud