Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fivetran Provider
  3. API Docs
  4. PrivateLink
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

fivetran.PrivateLink

Explore with Pulumi AI

fivetran logo
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

    This resource allows you to create, update, and delete private links.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  testPl:
    type: fivetran:PrivateLink
    properties:
      region: region
      service: service
      config:
        - connectionServiceName: connection_service_name
    options:
      provider: ${["fivetran-provider"]}

    Create PrivateLink Resource

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

    Constructor syntax

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

@overload
def PrivateLink(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                config_map: Optional[Mapping[str, str]] = None,
                region: Optional[str] = None,
                service: Optional[str] = None,
                name: Optional[str] = None)
    func NewPrivateLink(ctx *Context, name string, args PrivateLinkArgs, opts ...ResourceOption) (*PrivateLink, error)
    public PrivateLink(string name, PrivateLinkArgs args, CustomResourceOptions? opts = null)
    public PrivateLink(String name, PrivateLinkArgs args)
public PrivateLink(String name, PrivateLinkArgs args, CustomResourceOptions options)

    type: fivetran:PrivateLink
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 PrivateLinkArgs
    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 PrivateLinkArgs
    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 PrivateLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateLinkArgs
    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 privateLinkResource = new Fivetran.PrivateLink("privateLinkResource", new()
{
    ConfigMap = 
    {
        { "string", "string" },
    },
    Region = "string",
    Service = "string",
    Name = "string",
});

    example, err := fivetran.NewPrivateLink(ctx, "privateLinkResource", &fivetran.PrivateLinkArgs{
ConfigMap: pulumi.StringMap{
"string": pulumi.String("string"),
},
Region: pulumi.String("string"),
Service: pulumi.String("string"),
Name: pulumi.String("string"),
})

    var privateLinkResource = new PrivateLink("privateLinkResource", PrivateLinkArgs.builder()
    .configMap(Map.of("string", "string"))
    .region("string")
    .service("string")
    .name("string")
    .build());

    private_link_resource = fivetran.PrivateLink("privateLinkResource",
    config_map={
        "string": "string",
    },
    region="string",
    service="string",
    name="string")

    const privateLinkResource = new fivetran.PrivateLink("privateLinkResource", {
    configMap: {
        string: "string",
    },
    region: "string",
    service: "string",
    name: "string",
});

    type: fivetran:PrivateLink
properties:
    configMap:
        string: string
    name: string
    region: string
    service: string

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

    ConfigMap Dictionary<string, string>
    Configuration.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    Service string
    Service type.
    Name string
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    ConfigMap map[string]string
    Configuration.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    Service string
    Service type.
    Name string
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    configMap Map<String,String>
    Configuration.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    service String
    Service type.
    name String
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    configMap {[key: string]: string}
    Configuration.
    region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    service string
    Service type.
    name string
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    config_map Mapping[str, str]
    Configuration.
    region str
    Data processing location. This is where Fivetran will operate and run computation on data.
    service str
    Service type.
    name str
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    configMap Map<String>
    Configuration.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    service String
    Service type.
    name String
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.

    Outputs

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

    CloudProvider string
    The cloud provider name.
    CreatedAt string
    The date and time the membership was created.
    CreatedBy string
    The unique identifier for the User within the Fivetran system.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the private link.
    StateSummary string
    The state of the private link.
    CloudProvider string
    The cloud provider name.
    CreatedAt string
    The date and time the membership was created.
    CreatedBy string
    The unique identifier for the User within the Fivetran system.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The state of the private link.
    StateSummary string
    The state of the private link.
    cloudProvider String
    The cloud provider name.
    createdAt String
    The date and time the membership was created.
    createdBy String
    The unique identifier for the User within the Fivetran system.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the private link.
    stateSummary String
    The state of the private link.
    cloudProvider string
    The cloud provider name.
    createdAt string
    The date and time the membership was created.
    createdBy string
    The unique identifier for the User within the Fivetran system.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The state of the private link.
    stateSummary string
    The state of the private link.
    cloud_provider str
    The cloud provider name.
    created_at str
    The date and time the membership was created.
    created_by str
    The unique identifier for the User within the Fivetran system.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The state of the private link.
    state_summary str
    The state of the private link.
    cloudProvider String
    The cloud provider name.
    createdAt String
    The date and time the membership was created.
    createdBy String
    The unique identifier for the User within the Fivetran system.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The state of the private link.
    stateSummary String
    The state of the private link.

    Look up Existing PrivateLink Resource

    Get an existing PrivateLink 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?: PrivateLinkState, opts?: CustomResourceOptions): PrivateLink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_provider: Optional[str] = None,
        config_map: Optional[Mapping[str, str]] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        service: Optional[str] = None,
        state: Optional[str] = None,
        state_summary: Optional[str] = None) -> PrivateLink
    func GetPrivateLink(ctx *Context, name string, id IDInput, state *PrivateLinkState, opts ...ResourceOption) (*PrivateLink, error)
    public static PrivateLink Get(string name, Input<string> id, PrivateLinkState? state, CustomResourceOptions? opts = null)
    public static PrivateLink get(String name, Output<String> id, PrivateLinkState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:PrivateLink    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:
    CloudProvider string
    The cloud provider name.
    ConfigMap Dictionary<string, string>
    Configuration.
    CreatedAt string
    The date and time the membership was created.
    CreatedBy string
    The unique identifier for the User within the Fivetran system.
    Name string
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    Service string
    Service type.
    State string
    The state of the private link.
    StateSummary string
    The state of the private link.
    CloudProvider string
    The cloud provider name.
    ConfigMap map[string]string
    Configuration.
    CreatedAt string
    The date and time the membership was created.
    CreatedBy string
    The unique identifier for the User within the Fivetran system.
    Name string
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    Service string
    Service type.
    State string
    The state of the private link.
    StateSummary string
    The state of the private link.
    cloudProvider String
    The cloud provider name.
    configMap Map<String,String>
    Configuration.
    createdAt String
    The date and time the membership was created.
    createdBy String
    The unique identifier for the User within the Fivetran system.
    name String
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    service String
    Service type.
    state String
    The state of the private link.
    stateSummary String
    The state of the private link.
    cloudProvider string
    The cloud provider name.
    configMap {[key: string]: string}
    Configuration.
    createdAt string
    The date and time the membership was created.
    createdBy string
    The unique identifier for the User within the Fivetran system.
    name string
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    service string
    Service type.
    state string
    The state of the private link.
    stateSummary string
    The state of the private link.
    cloud_provider str
    The cloud provider name.
    config_map Mapping[str, str]
    Configuration.
    created_at str
    The date and time the membership was created.
    created_by str
    The unique identifier for the User within the Fivetran system.
    name str
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    region str
    Data processing location. This is where Fivetran will operate and run computation on data.
    service str
    Service type.
    state str
    The state of the private link.
    state_summary str
    The state of the private link.
    cloudProvider String
    The cloud provider name.
    configMap Map<String>
    Configuration.
    createdAt String
    The date and time the membership was created.
    createdBy String
    The unique identifier for the User within the Fivetran system.
    name String
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    service String
    Service type.
    state String
    The state of the private link.
    stateSummary String
    The state of the private link.

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
    fivetran/terraform-provider-fivetran