dbt Cloud v0.1.23 published on Tuesday, Oct 29, 2024 by Pulumi
dbtcloud.GroupPartialPermissions
Explore with Pulumi AI
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dbtcloud.GroupPartialPermissions;
import com.pulumi.dbtcloud.GroupPartialPermissionsArgs;
import com.pulumi.dbtcloud.inputs.GroupPartialPermissionsGroupPermissionArgs;
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) {
// we add some permissions to the group "TF Group 1" (existing or not) to a new project
var tfGroup1 = new GroupPartialPermissions("tfGroup1", GroupPartialPermissionsArgs.builder()
.name("TF Group 1")
.groupPermissions(
GroupPartialPermissionsGroupPermissionArgs.builder()
.permission_set("developer")
.project_id(dbtProject.id())
.all_projects(false)
.writable_environment_categories(
"development",
"staging")
.build(),
GroupPartialPermissionsGroupPermissionArgs.builder()
.permission_set("git_admin")
.project_id(dbtProject.id())
.all_projects(false)
.build())
.build());
// we add Admin permissions to the group "TF Group 2" (existing or not) to a new project
// it is possible to add more permissions to the same group name in other Terraform projects/workspaces, using another `dbtcloud_group_partial_permissions` resource
var tfGroup2 = new GroupPartialPermissions("tfGroup2", GroupPartialPermissionsArgs.builder()
.name("TF Group 2")
.ssoMappingGroups("group2")
.groupPermissions(GroupPartialPermissionsGroupPermissionArgs.builder()
.permission_set("admin")
.project_id(dbtProject.id())
.all_projects(false)
.build())
.build());
}
}
resources:
# we add some permissions to the group "TF Group 1" (existing or not) to a new project
tfGroup1:
type: dbtcloud:GroupPartialPermissions
name: tf_group_1
properties:
name: TF Group 1
groupPermissions:
- permission_set: developer
project_id: ${dbtProject.id}
all_projects: false
writable_environment_categories:
- development
- staging
- permission_set: git_admin
project_id: ${dbtProject.id}
all_projects: false
# we add Admin permissions to the group "TF Group 2" (existing or not) to a new project
# // it is possible to add more permissions to the same group name in other Terraform projects/workspaces, using another `dbtcloud_group_partial_permissions` resource
tfGroup2:
type: dbtcloud:GroupPartialPermissions
name: tf_group_2
properties:
name: TF Group 2
ssoMappingGroups:
- group2
groupPermissions:
- permission_set: admin
project_id: ${dbtProject.id}
all_projects: false
Create GroupPartialPermissions Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GroupPartialPermissions(name: string, args?: GroupPartialPermissionsArgs, opts?: CustomResourceOptions);
@overload
def GroupPartialPermissions(resource_name: str,
args: Optional[GroupPartialPermissionsArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def GroupPartialPermissions(resource_name: str,
opts: Optional[ResourceOptions] = None,
assign_by_default: Optional[bool] = None,
group_permissions: Optional[Sequence[GroupPartialPermissionsGroupPermissionArgs]] = None,
name: Optional[str] = None,
sso_mapping_groups: Optional[Sequence[str]] = None)
func NewGroupPartialPermissions(ctx *Context, name string, args *GroupPartialPermissionsArgs, opts ...ResourceOption) (*GroupPartialPermissions, error)
public GroupPartialPermissions(string name, GroupPartialPermissionsArgs? args = null, CustomResourceOptions? opts = null)
public GroupPartialPermissions(String name, GroupPartialPermissionsArgs args)
public GroupPartialPermissions(String name, GroupPartialPermissionsArgs args, CustomResourceOptions options)
type: dbtcloud:GroupPartialPermissions
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 GroupPartialPermissionsArgs
- 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 GroupPartialPermissionsArgs
- 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 GroupPartialPermissionsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GroupPartialPermissionsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GroupPartialPermissionsArgs
- 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 groupPartialPermissionsResource = new DbtCloud.GroupPartialPermissions("groupPartialPermissionsResource", new()
{
AssignByDefault = false,
GroupPermissions = new[]
{
new DbtCloud.Inputs.GroupPartialPermissionsGroupPermissionArgs
{
AllProjects = false,
PermissionSet = "string",
ProjectId = 0,
WritableEnvironmentCategories = new[]
{
"string",
},
},
},
Name = "string",
SsoMappingGroups = new[]
{
"string",
},
});
example, err := dbtcloud.NewGroupPartialPermissions(ctx, "groupPartialPermissionsResource", &dbtcloud.GroupPartialPermissionsArgs{
AssignByDefault: pulumi.Bool(false),
GroupPermissions: dbtcloud.GroupPartialPermissionsGroupPermissionArray{
&dbtcloud.GroupPartialPermissionsGroupPermissionArgs{
AllProjects: pulumi.Bool(false),
PermissionSet: pulumi.String("string"),
ProjectId: pulumi.Int(0),
WritableEnvironmentCategories: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
SsoMappingGroups: pulumi.StringArray{
pulumi.String("string"),
},
})
var groupPartialPermissionsResource = new GroupPartialPermissions("groupPartialPermissionsResource", GroupPartialPermissionsArgs.builder()
.assignByDefault(false)
.groupPermissions(GroupPartialPermissionsGroupPermissionArgs.builder()
.allProjects(false)
.permissionSet("string")
.projectId(0)
.writableEnvironmentCategories("string")
.build())
.name("string")
.ssoMappingGroups("string")
.build());
group_partial_permissions_resource = dbtcloud.GroupPartialPermissions("groupPartialPermissionsResource",
assign_by_default=False,
group_permissions=[dbtcloud.GroupPartialPermissionsGroupPermissionArgs(
all_projects=False,
permission_set="string",
project_id=0,
writable_environment_categories=["string"],
)],
name="string",
sso_mapping_groups=["string"])
const groupPartialPermissionsResource = new dbtcloud.GroupPartialPermissions("groupPartialPermissionsResource", {
assignByDefault: false,
groupPermissions: [{
allProjects: false,
permissionSet: "string",
projectId: 0,
writableEnvironmentCategories: ["string"],
}],
name: "string",
ssoMappingGroups: ["string"],
});
type: dbtcloud:GroupPartialPermissions
properties:
assignByDefault: false
groupPermissions:
- allProjects: false
permissionSet: string
projectId: 0
writableEnvironmentCategories:
- string
name: string
ssoMappingGroups:
- string
GroupPartialPermissions Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The GroupPartialPermissions resource accepts the following input properties:
- Assign
By boolDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- Group
Permissions List<Pulumi.Dbt Cloud. Inputs. Group Partial Permissions Group Permission> - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- Name string
- The name of the group. This is used to identify an existing group
- Sso
Mapping List<string>Groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- Assign
By boolDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- Group
Permissions []GroupPartial Permissions Group Permission Args - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- Name string
- The name of the group. This is used to identify an existing group
- Sso
Mapping []stringGroups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- assign
By BooleanDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- group
Permissions List<GroupPartial Permissions Group Permission> - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- name String
- The name of the group. This is used to identify an existing group
- sso
Mapping List<String>Groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- assign
By booleanDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- group
Permissions GroupPartial Permissions Group Permission[] - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- name string
- The name of the group. This is used to identify an existing group
- sso
Mapping string[]Groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- assign_
by_ booldefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- group_
permissions Sequence[GroupPartial Permissions Group Permission Args] - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- name str
- The name of the group. This is used to identify an existing group
- sso_
mapping_ Sequence[str]groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- assign
By BooleanDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- group
Permissions List<Property Map> - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- name String
- The name of the group. This is used to identify an existing group
- sso
Mapping List<String>Groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
Outputs
All input properties are implicitly available as output properties. Additionally, the GroupPartialPermissions 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 GroupPartialPermissions Resource
Get an existing GroupPartialPermissions 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?: GroupPartialPermissionsState, opts?: CustomResourceOptions): GroupPartialPermissions
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
assign_by_default: Optional[bool] = None,
group_permissions: Optional[Sequence[GroupPartialPermissionsGroupPermissionArgs]] = None,
name: Optional[str] = None,
sso_mapping_groups: Optional[Sequence[str]] = None) -> GroupPartialPermissions
func GetGroupPartialPermissions(ctx *Context, name string, id IDInput, state *GroupPartialPermissionsState, opts ...ResourceOption) (*GroupPartialPermissions, error)
public static GroupPartialPermissions Get(string name, Input<string> id, GroupPartialPermissionsState? state, CustomResourceOptions? opts = null)
public static GroupPartialPermissions get(String name, Output<String> id, GroupPartialPermissionsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Assign
By boolDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- Group
Permissions List<Pulumi.Dbt Cloud. Inputs. Group Partial Permissions Group Permission> - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- Name string
- The name of the group. This is used to identify an existing group
- Sso
Mapping List<string>Groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- Assign
By boolDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- Group
Permissions []GroupPartial Permissions Group Permission Args - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- Name string
- The name of the group. This is used to identify an existing group
- Sso
Mapping []stringGroups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- assign
By BooleanDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- group
Permissions List<GroupPartial Permissions Group Permission> - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- name String
- The name of the group. This is used to identify an existing group
- sso
Mapping List<String>Groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- assign
By booleanDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- group
Permissions GroupPartial Permissions Group Permission[] - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- name string
- The name of the group. This is used to identify an existing group
- sso
Mapping string[]Groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- assign_
by_ booldefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- group_
permissions Sequence[GroupPartial Permissions Group Permission Args] - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- name str
- The name of the group. This is used to identify an existing group
- sso_
mapping_ Sequence[str]groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
- assign
By BooleanDefault - Whether the group will be assigned by default to users. The value needs to be the same for all partial permissions for the same group.
- group
Permissions List<Property Map> - Partial permissions for the group. Those permissions will be added/removed when config is added/removed.
- name String
- The name of the group. This is used to identify an existing group
- sso
Mapping List<String>Groups - Mapping groups from the IdP. At the moment the complete list needs to be provided in each partial permission for the same group.
Supporting Types
GroupPartialPermissionsGroupPermission, GroupPartialPermissionsGroupPermissionArgs
- All
Projects bool - Whether access should be provided for all projects or not.
- Permission
Set string - Set of permissions to apply. The permissions allowed are the same as the ones for the
dbtcloud.Group
resource. - Project
Id int - Project ID to apply this permission to for this group.
- Writable
Environment List<string>Categories - What types of environments to apply Write permissions to.
Even if Write access is restricted to some environment types, the permission set will have Read access to all environments.
The values allowed are
all
,development
,staging
,production
andother
. Not setting a value is the same as selectingall
. Not all permission sets support environment level write settings, onlyanalyst
,database_admin
,developer
,git_admin
andteam_admin
.
- All
Projects bool - Whether access should be provided for all projects or not.
- Permission
Set string - Set of permissions to apply. The permissions allowed are the same as the ones for the
dbtcloud.Group
resource. - Project
Id int - Project ID to apply this permission to for this group.
- Writable
Environment []stringCategories - What types of environments to apply Write permissions to.
Even if Write access is restricted to some environment types, the permission set will have Read access to all environments.
The values allowed are
all
,development
,staging
,production
andother
. Not setting a value is the same as selectingall
. Not all permission sets support environment level write settings, onlyanalyst
,database_admin
,developer
,git_admin
andteam_admin
.
- all
Projects Boolean - Whether access should be provided for all projects or not.
- permission
Set String - Set of permissions to apply. The permissions allowed are the same as the ones for the
dbtcloud.Group
resource. - project
Id Integer - Project ID to apply this permission to for this group.
- writable
Environment List<String>Categories - What types of environments to apply Write permissions to.
Even if Write access is restricted to some environment types, the permission set will have Read access to all environments.
The values allowed are
all
,development
,staging
,production
andother
. Not setting a value is the same as selectingall
. Not all permission sets support environment level write settings, onlyanalyst
,database_admin
,developer
,git_admin
andteam_admin
.
- all
Projects boolean - Whether access should be provided for all projects or not.
- permission
Set string - Set of permissions to apply. The permissions allowed are the same as the ones for the
dbtcloud.Group
resource. - project
Id number - Project ID to apply this permission to for this group.
- writable
Environment string[]Categories - What types of environments to apply Write permissions to.
Even if Write access is restricted to some environment types, the permission set will have Read access to all environments.
The values allowed are
all
,development
,staging
,production
andother
. Not setting a value is the same as selectingall
. Not all permission sets support environment level write settings, onlyanalyst
,database_admin
,developer
,git_admin
andteam_admin
.
- all_
projects bool - Whether access should be provided for all projects or not.
- permission_
set str - Set of permissions to apply. The permissions allowed are the same as the ones for the
dbtcloud.Group
resource. - project_
id int - Project ID to apply this permission to for this group.
- writable_
environment_ Sequence[str]categories - What types of environments to apply Write permissions to.
Even if Write access is restricted to some environment types, the permission set will have Read access to all environments.
The values allowed are
all
,development
,staging
,production
andother
. Not setting a value is the same as selectingall
. Not all permission sets support environment level write settings, onlyanalyst
,database_admin
,developer
,git_admin
andteam_admin
.
- all
Projects Boolean - Whether access should be provided for all projects or not.
- permission
Set String - Set of permissions to apply. The permissions allowed are the same as the ones for the
dbtcloud.Group
resource. - project
Id Number - Project ID to apply this permission to for this group.
- writable
Environment List<String>Categories - What types of environments to apply Write permissions to.
Even if Write access is restricted to some environment types, the permission set will have Read access to all environments.
The values allowed are
all
,development
,staging
,production
andother
. Not setting a value is the same as selectingall
. Not all permission sets support environment level write settings, onlyanalyst
,database_admin
,developer
,git_admin
andteam_admin
.
Package Details
- Repository
- dbtcloud pulumi/pulumi-dbtcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
dbtcloud
Terraform Provider.