1. Packages
  2. Packages
  3. Formal Provider
  4. API Docs
  5. ResourceDialConfiguration
Viewing docs for Formal v1.2.0
published on Saturday, Jun 6, 2026 by Formal
formal logo
Viewing docs for Formal v1.2.0
published on Saturday, Jun 6, 2026 by Formal

    Creating a Dial Configuration of a Resource in Formal.

    Create ResourceDialConfiguration Resource

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

    Constructor syntax

    new ResourceDialConfiguration(name: string, args: ResourceDialConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def ResourceDialConfiguration(resource_name: str,
                                  args: ResourceDialConfigurationArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ResourceDialConfiguration(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  dial_method: Optional[str] = None,
                                  resource_id: Optional[str] = None,
                                  dial_target: Optional[str] = None)
    func NewResourceDialConfiguration(ctx *Context, name string, args ResourceDialConfigurationArgs, opts ...ResourceOption) (*ResourceDialConfiguration, error)
    public ResourceDialConfiguration(string name, ResourceDialConfigurationArgs args, CustomResourceOptions? opts = null)
    public ResourceDialConfiguration(String name, ResourceDialConfigurationArgs args)
    public ResourceDialConfiguration(String name, ResourceDialConfigurationArgs args, CustomResourceOptions options)
    
    type: formal:ResourceDialConfiguration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "formal_resourcedialconfiguration" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ResourceDialConfigurationArgs
    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 ResourceDialConfigurationArgs
    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 ResourceDialConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResourceDialConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResourceDialConfigurationArgs
    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 resourceDialConfigurationResource = new Pulumi.ResourceDialConfiguration("resourceDialConfigurationResource", new()
    {
        DialMethod = "string",
        ResourceId = "string",
        DialTarget = "string",
    });
    
    example, err := formal.NewResourceDialConfiguration(ctx, "resourceDialConfigurationResource", &formal.ResourceDialConfigurationArgs{
    	DialMethod: pulumi.String("string"),
    	ResourceId: pulumi.String("string"),
    	DialTarget: pulumi.String("string"),
    })
    
    resource "formal_resourcedialconfiguration" "resourceDialConfigurationResource" {
      dial_method = "string"
      resource_id = "string"
      dial_target = "string"
    }
    
    var resourceDialConfigurationResource = new ResourceDialConfiguration("resourceDialConfigurationResource", ResourceDialConfigurationArgs.builder()
        .dialMethod("string")
        .resourceId("string")
        .dialTarget("string")
        .build());
    
    resource_dial_configuration_resource = formal.ResourceDialConfiguration("resourceDialConfigurationResource",
        dial_method="string",
        resource_id="string",
        dial_target="string")
    
    const resourceDialConfigurationResource = new formal.ResourceDialConfiguration("resourceDialConfigurationResource", {
        dialMethod: "string",
        resourceId: "string",
        dialTarget: "string",
    });
    
    type: formal:ResourceDialConfiguration
    properties:
        dialMethod: string
        dialTarget: string
        resourceId: string
    

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

    DialMethod string
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    ResourceId string
    Resource ID for which the dial configuration is applied to.
    DialTarget string
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    DialMethod string
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    ResourceId string
    Resource ID for which the dial configuration is applied to.
    DialTarget string
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    dial_method string
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    resource_id string
    Resource ID for which the dial configuration is applied to.
    dial_target string
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    dialMethod String
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    resourceId String
    Resource ID for which the dial configuration is applied to.
    dialTarget String
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    dialMethod string
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    resourceId string
    Resource ID for which the dial configuration is applied to.
    dialTarget string
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    dial_method str
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    resource_id str
    Resource ID for which the dial configuration is applied to.
    dial_target str
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    dialMethod String
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    resourceId String
    Resource ID for which the dial configuration is applied to.
    dialTarget String
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ResourceDialConfiguration 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.

    Look up Existing ResourceDialConfiguration Resource

    Get an existing ResourceDialConfiguration 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?: ResourceDialConfigurationState, opts?: CustomResourceOptions): ResourceDialConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dial_method: Optional[str] = None,
            dial_target: Optional[str] = None,
            resource_id: Optional[str] = None) -> ResourceDialConfiguration
    func GetResourceDialConfiguration(ctx *Context, name string, id IDInput, state *ResourceDialConfigurationState, opts ...ResourceOption) (*ResourceDialConfiguration, error)
    public static ResourceDialConfiguration Get(string name, Input<string> id, ResourceDialConfigurationState? state, CustomResourceOptions? opts = null)
    public static ResourceDialConfiguration get(String name, Output<String> id, ResourceDialConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: formal:ResourceDialConfiguration    get:      id: ${id}
    import {
      to = formal_resourcedialconfiguration.example
      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:
    DialMethod string
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    DialTarget string
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    ResourceId string
    Resource ID for which the dial configuration is applied to.
    DialMethod string
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    DialTarget string
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    ResourceId string
    Resource ID for which the dial configuration is applied to.
    dial_method string
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    dial_target string
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    resource_id string
    Resource ID for which the dial configuration is applied to.
    dialMethod String
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    dialTarget String
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    resourceId String
    Resource ID for which the dial configuration is applied to.
    dialMethod string
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    dialTarget string
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    resourceId string
    Resource ID for which the dial configuration is applied to.
    dial_method str
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    dial_target str
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    resource_id str
    Resource ID for which the dial configuration is applied to.
    dialMethod String
    How the connector dials this resource's upstream. Supported values are: tcp (direct TCP via the resource's hostname and port), gcpCloudsql (dial via the GCP Cloud SQL connector library — dialTarget must be set to the project:region:instance connection name).
    dialTarget String
    Method-specific dial target. For gcpCloudsql, the project:region:instance connection name. Leave empty for tcp.
    resourceId String
    Resource ID for which the dial configuration is applied to.

    Package Details

    Repository
    formal formalco/pulumi-formal
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the formal Terraform Provider.
    formal logo
    Viewing docs for Formal v1.2.0
    published on Saturday, Jun 6, 2026 by Formal

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial