1. Packages
  2. Fivetran Provider
  3. API Docs
  4. getRoles
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran

fivetran.getRoles

Explore with Pulumi AI

fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran

This data source returns a list of all predefined and custom roles within your Fivetran account.

Example Usage

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

const roles = fivetran.getRoles({});
Copy
import pulumi
import pulumi_fivetran as fivetran

roles = fivetran.get_roles()
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fivetran/fivetran"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fivetran.GetRoles(ctx, &fivetran.GetRolesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fivetran = Pulumi.Fivetran;

return await Deployment.RunAsync(() => 
{
    var roles = Fivetran.GetRoles.Invoke();

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.FivetranFunctions;
import com.pulumi.fivetran.inputs.GetRolesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var roles = FivetranFunctions.getRoles();

    }
}
Copy
variables:
  roles:
    fn::invoke:
      function: fivetran:getRoles
      arguments: {}
Copy

Using getRoles

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRoles(args: GetRolesArgs, opts?: InvokeOptions): Promise<GetRolesResult>
function getRolesOutput(args: GetRolesOutputArgs, opts?: InvokeOptions): Output<GetRolesResult>
Copy
def get_roles(roles: Optional[Sequence[GetRolesRole]] = None,
              opts: Optional[InvokeOptions] = None) -> GetRolesResult
def get_roles_output(roles: Optional[pulumi.Input[Sequence[pulumi.Input[GetRolesRoleArgs]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRolesResult]
Copy
func GetRoles(ctx *Context, args *GetRolesArgs, opts ...InvokeOption) (*GetRolesResult, error)
func GetRolesOutput(ctx *Context, args *GetRolesOutputArgs, opts ...InvokeOption) GetRolesResultOutput
Copy

> Note: This function is named GetRoles in the Go SDK.

public static class GetRoles 
{
    public static Task<GetRolesResult> InvokeAsync(GetRolesArgs args, InvokeOptions? opts = null)
    public static Output<GetRolesResult> Invoke(GetRolesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRolesResult> getRoles(GetRolesArgs args, InvokeOptions options)
public static Output<GetRolesResult> getRoles(GetRolesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: fivetran:index/getRoles:getRoles
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

getRoles Result

The following output properties are available:

Id string
The ID of this resource.
Roles List<GetRolesRole>
Id string
The ID of this resource.
Roles []GetRolesRole
id String
The ID of this resource.
roles List<GetRolesRole>
id string
The ID of this resource.
roles GetRolesRole[]
id str
The ID of this resource.
roles Sequence[GetRolesRole]
id String
The ID of this resource.
roles List<Property Map>

Supporting Types

GetRolesRole

Description This property is required. string
The role description
IsCustom This property is required. bool
TypeBool
Name This property is required. string
The role name
Scopes This property is required. List<string>
Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
Description This property is required. string
The role description
IsCustom This property is required. bool
TypeBool
Name This property is required. string
The role name
Scopes This property is required. []string
Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
description This property is required. String
The role description
isCustom This property is required. Boolean
TypeBool
name This property is required. String
The role name
scopes This property is required. List<String>
Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
description This property is required. string
The role description
isCustom This property is required. boolean
TypeBool
name This property is required. string
The role name
scopes This property is required. string[]
Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
description This property is required. str
The role description
is_custom This property is required. bool
TypeBool
name This property is required. str
The role name
scopes This property is required. Sequence[str]
Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
description This property is required. String
The role description
isCustom This property is required. Boolean
TypeBool
name This property is required. String
The role name
scopes This property is required. List<String>
Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM

Package Details

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