`groupRole` Submodule

Constructs

GroupRole

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role okta_group_role}.

Initializers

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/grouprole"

grouprole.NewGroupRole(scope Construct, id *string, config GroupRoleConfig) GroupRole

Name	Type	Description
`scope`	`github.com/aws/constructs-go/constructs/v10.Construct`	The scope in which to define this construct.
`id`	`*string`	The scoped construct ID.
`config`	`GroupRoleConfig`	No description.

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

`id`^Required

Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: GroupRoleConfig

Methods

Name	Description
`ToString`	Returns a string representation of this construct.
`AddOverride`	No description.
`OverrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`ResetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`ToHclTerraform`	No description.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`AddMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`HasResourceMove`	No description.
`ImportFrom`	No description.
`InterpolationForAttribute`	No description.
`MoveFromId`	Move the resource corresponding to "id" to this resource.
`MoveTo`	Moves this resource to the target resource given by moveTarget.
`MoveToId`	Moves this resource to the resource corresponding to "id".
`ResetDisableNotifications`	No description.
`ResetId`	No description.
`ResetResourceSetId`	No description.
`ResetRoleId`	No description.
`ResetTargetAppList`	No description.
`ResetTargetGroupList`	No description.

`ToString`

func ToString() *string

Returns a string representation of this construct.

`AddOverride`

func AddOverride(path *string, value interface{})

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`OverrideLogicalId`

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

Type: *string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

`ToHclTerraform`

func ToHclTerraform() interface{}

`ToMetadata`

func ToMetadata() interface{}

`ToTerraform`

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

`AddMoveTarget`

func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: *string

The string move target that will correspond to this resource.

`GetAnyMapAttribute`

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

`terraformAttribute`^Required

Type: *string

`GetBooleanAttribute`

func GetBooleanAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`GetBooleanMapAttribute`

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

`terraformAttribute`^Required

Type: *string

`GetListAttribute`

func GetListAttribute(terraformAttribute *string) *[]*string

`terraformAttribute`^Required

Type: *string

`GetNumberAttribute`

func GetNumberAttribute(terraformAttribute *string) *f64

`terraformAttribute`^Required

Type: *string

`GetNumberListAttribute`

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

`terraformAttribute`^Required

Type: *string

`GetNumberMapAttribute`

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

`terraformAttribute`^Required

Type: *string

`GetStringAttribute`

func GetStringAttribute(terraformAttribute *string) *string

`terraformAttribute`^Required

Type: *string

`GetStringMapAttribute`

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

`terraformAttribute`^Required

Type: *string

`HasResourceMove`

func HasResourceMove() interface{}

`ImportFrom`

func ImportFrom(id *string, provider TerraformProvider)

`id`^Required

Type: *string

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`InterpolationForAttribute`

func InterpolationForAttribute(terraformAttribute *string) IResolvable

`terraformAttribute`^Required

Type: *string

`MoveFromId`

func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`MoveTo`

func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`MoveToId`

func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`ResetDisableNotifications`

func ResetDisableNotifications()

`ResetId`

func ResetId()

`ResetResourceSetId`

func ResetResourceSetId()

`ResetRoleId`

func ResetRoleId()

`ResetTargetAppList`

func ResetTargetAppList()

`ResetTargetGroupList`

func ResetTargetGroupList()

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsTerraformResource`	No description.
`GenerateConfigForImport`	Generates CDKTF code for importing a GroupRole resource upon running "cdktf plan ".

`IsConstruct`

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/grouprole"

grouprole.GroupRole_IsConstruct(x interface{}) *bool

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: interface{}

Any object.

`IsTerraformElement`

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/grouprole"

grouprole.GroupRole_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

`IsTerraformResource`

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/grouprole"

grouprole.GroupRole_IsTerraformResource(x interface{}) *bool

`x`^Required

Type: interface{}

`GenerateConfigForImport`

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/grouprole"

grouprole.GroupRole_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a GroupRole resource upon running "cdktf plan ".

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

`importToId`^Required

Type: *string

The construct id used in the generated config for the GroupRole to import.

`importFromId`^Required

Type: *string

The id of the existing GroupRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the GroupRole to import is found.

Properties

Name	Type	Description
`Node`	`github.com/aws/constructs-go/constructs/v10.Node`	The tree node.
`CdktfStack`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack`	No description.
`Fqn`	`*string`	No description.
`FriendlyUniqueId`	`*string`	No description.
`TerraformMetaArguments`	`*map[string]interface{}`	No description.
`TerraformResourceType`	`*string`	No description.
`TerraformGeneratorMetadata`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata`	No description.
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`[]string`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	No description.
`DisableNotificationsInput`	`interface{}`	No description.
`GroupIdInput`	`*string`	No description.
`IdInput`	`*string`	No description.
`ResourceSetIdInput`	`*string`	No description.
`RoleIdInput`	`*string`	No description.
`RoleTypeInput`	`*string`	No description.
`TargetAppListInput`	`[]string`	No description.
`TargetGroupListInput`	`[]string`	No description.
`DisableNotifications`	`interface{}`	No description.
`GroupId`	`*string`	No description.
`Id`	`*string`	No description.
`ResourceSetId`	`*string`	No description.
`RoleId`	`*string`	No description.
`RoleType`	`*string`	No description.
`TargetAppList`	`[]string`	No description.
`TargetGroupList`	`[]string`	No description.

`Node`^Required

func Node() Node

Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

`CdktfStack`^Required

func CdktfStack() TerraformStack

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

`Fqn`^Required

func Fqn() *string

Type: *string

`FriendlyUniqueId`^Required

func FriendlyUniqueId() *string

Type: *string

`TerraformMetaArguments`^Required

func TerraformMetaArguments() *map[string]interface{}

Type: *map[string]interface{}

`TerraformResourceType`^Required

func TerraformResourceType() *string

Type: *string

`TerraformGeneratorMetadata`^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

`Connection`^Optional

func Connection() interface{}

Type: interface{}

`Count`^Optional

func Count() interface{}

Type: interface{}

`DependsOn`^Optional

func DependsOn() *[]*string

Type: *[]*string

`ForEach`^Optional

func ForEach() ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

func Lifecycle() TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

func Provider() TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

func Provisioners() *[]interface{}

Type: *[]interface{}

`DisableNotificationsInput`^Optional

func DisableNotificationsInput() interface{}

Type: interface{}

`GroupIdInput`^Optional

func GroupIdInput() *string

Type: *string

`IdInput`^Optional

func IdInput() *string

Type: *string

`ResourceSetIdInput`^Optional

func ResourceSetIdInput() *string

Type: *string

`RoleIdInput`^Optional

func RoleIdInput() *string

Type: *string

`RoleTypeInput`^Optional

func RoleTypeInput() *string

Type: *string

`TargetAppListInput`^Optional

func TargetAppListInput() *[]*string

Type: *[]*string

`TargetGroupListInput`^Optional

func TargetGroupListInput() *[]*string

Type: *[]*string

`DisableNotifications`^Required

func DisableNotifications() interface{}

Type: interface{}

`GroupId`^Required

func GroupId() *string

Type: *string

`Id`^Required

func Id() *string

Type: *string

`ResourceSetId`^Required

func ResourceSetId() *string

Type: *string

`RoleId`^Required

func RoleId() *string

Type: *string

`RoleType`^Required

func RoleType() *string

Type: *string

`TargetAppList`^Required

func TargetAppList() *[]*string

Type: *[]*string

`TargetGroupList`^Required

func TargetGroupList() *[]*string

Type: *[]*string

Constants

Name	Type	Description
`TfResourceType`	`*string`	No description.

`TfResourceType`^Required

func TfResourceType() *string

Type: *string

Structs

GroupRoleConfig

Initializer

import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/grouprole"

&grouprole.GroupRoleConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	GroupId: *string,
	RoleType: *string,
	DisableNotifications: interface{},
	Id: *string,
	ResourceSetId: *string,
	RoleId: *string,
	TargetAppList: *[]*string,
	TargetGroupList: *[]*string,
}

Properties

Name	Type	Description
`Connection`	`interface{}`	No description.
`Count`	`interface{}`	No description.
`DependsOn`	`*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable`	No description.
`ForEach`	`github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator`	No description.
`Lifecycle`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider`	No description.
`Provisioners`	`*[]interface{}`	No description.
`GroupId`	`*string`	ID of group to attach admin roles to.
`RoleType`	`*string`	Admin role assigned to the group.
`DisableNotifications`	`interface{}`	When this setting is enabled, the admins won't receive any of the default Okta administrator emails.
`Id`	`*string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#id GroupRole#id}.
`ResourceSetId`	`*string`	Resource Set ID. Required for role_type = `CUSTOM`.
`RoleId`	`*string`	Role ID. Required for role_type = `CUSTOM`.
`TargetAppList`	`[]string`	A list of app names (name represents set of app instances, like 'salesforce' or 'facebook'), or a combination of app name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as the targets of the admin role. - Only supported when used with the role type `APP_ADMIN`.
`TargetGroupList`	`[]string`	A list of group IDs you would like as the targets of the admin role.

`Connection`^Optional

Connection interface{}

Type: interface{}

`Count`^Optional

Count interface{}

Type: interface{}

`DependsOn`^Optional

DependsOn *[]ITerraformDependable

Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

`ForEach`^Optional

ForEach ITerraformIterator

Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

`Lifecycle`^Optional

Lifecycle TerraformResourceLifecycle

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

`Provider`^Optional

Provider TerraformProvider

Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

`Provisioners`^Optional

Provisioners *[]interface{}

Type: *[]interface{}

`GroupId`^Required

GroupId *string

Type: *string

ID of group to attach admin roles to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#group_id GroupRole#group_id}

`RoleType`^Required

RoleType *string

Type: *string

Admin role assigned to the group.

It can be any one of the following values: "API_ADMIN", "APP_ADMIN", "CUSTOM", "GROUP_MEMBERSHIP_ADMIN", "HELP_DESK_ADMIN", "MOBILE_ADMIN", "ORG_ADMIN", "READ_ONLY_ADMIN", "REPORT_ADMIN", "SUPER_ADMIN", "USER_ADMIN" . See API Docs.

"USER_ADMIN" is the Group Administrator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#role_type GroupRole#role_type}

`DisableNotifications`^Optional

DisableNotifications interface{}

Type: interface{}

When this setting is enabled, the admins won't receive any of the default Okta administrator emails.

These admins also won't have access to contact Okta Support and open support cases on behalf of your org.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#disable_notifications GroupRole#disable_notifications}

`Id`^Optional

Id *string

Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#id GroupRole#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`ResourceSetId`^Optional

ResourceSetId *string

Type: *string

Resource Set ID. Required for role_type = CUSTOM.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#resource_set_id GroupRole#resource_set_id}

`RoleId`^Optional

RoleId *string

Type: *string

Role ID. Required for role_type = CUSTOM.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#role_id GroupRole#role_id}

`TargetAppList`^Optional

TargetAppList *[]*string

Type: *[]*string

A list of app names (name represents set of app instances, like 'salesforce' or 'facebook'), or a combination of app name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as the targets of the admin role. - Only supported when used with the role type APP_ADMIN.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#target_app_list GroupRole#target_app_list}

`TargetGroupList`^Optional

TargetGroupList *[]*string

Type: *[]*string

A list of group IDs you would like as the targets of the admin role.

Only supported when used with the role types: GROUP_MEMBERSHIP_ADMIN, HELP_DESK_ADMIN, or USER_ADMIN.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/group_role#target_group_list GroupRole#target_group_list}

Files

groupRole.go.md

Latest commit

History

groupRole.go.md

File metadata and controls

groupRole Submodule

Constructs

GroupRole

Initializers

scopeRequired

idRequired

configRequired

Methods

ToString

AddOverride

pathRequired

valueRequired

OverrideLogicalId

newLogicalIdRequired

ResetOverrideLogicalId

ToHclTerraform

ToMetadata

ToTerraform

AddMoveTarget

moveTargetRequired

GetAnyMapAttribute

terraformAttributeRequired

GetBooleanAttribute

terraformAttributeRequired

GetBooleanMapAttribute

terraformAttributeRequired

GetListAttribute

terraformAttributeRequired

GetNumberAttribute

terraformAttributeRequired

GetNumberListAttribute

terraformAttributeRequired

GetNumberMapAttribute

terraformAttributeRequired

GetStringAttribute

terraformAttributeRequired

GetStringMapAttribute

terraformAttributeRequired

HasResourceMove

ImportFrom

idRequired

providerOptional

InterpolationForAttribute

terraformAttributeRequired

MoveFromId

idRequired

MoveTo

moveTargetRequired

indexOptional

MoveToId

idRequired

ResetDisableNotifications

ResetId

ResetResourceSetId

ResetRoleId

ResetTargetAppList

ResetTargetGroupList

Static Functions

IsConstruct

xRequired

IsTerraformElement

xRequired

IsTerraformResource

xRequired

GenerateConfigForImport

scopeRequired

importToIdRequired

importFromIdRequired

providerOptional

Properties

NodeRequired

CdktfStackRequired

FqnRequired

FriendlyUniqueIdRequired

`groupRole` Submodule

`scope`^Required

`id`^Required

`config`^Required

`ToString`

`AddOverride`

`path`^Required

`value`^Required

`OverrideLogicalId`

`newLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`AddMoveTarget`

`moveTarget`^Required

`GetAnyMapAttribute`

`terraformAttribute`^Required

`GetBooleanAttribute`

`terraformAttribute`^Required

`GetBooleanMapAttribute`

`terraformAttribute`^Required

`GetListAttribute`

`terraformAttribute`^Required

`GetNumberAttribute`

`terraformAttribute`^Required

`GetNumberListAttribute`

`terraformAttribute`^Required

`GetNumberMapAttribute`

`terraformAttribute`^Required

`GetStringAttribute`

`terraformAttribute`^Required

`GetStringMapAttribute`

`terraformAttribute`^Required

`HasResourceMove`

`ImportFrom`

`id`^Required

`provider`^Optional

`InterpolationForAttribute`

`terraformAttribute`^Required

`MoveFromId`

`id`^Required

`MoveTo`

`moveTarget`^Required

`index`^Optional

`MoveToId`

`id`^Required

`ResetDisableNotifications`

`ResetId`

`ResetResourceSetId`

`ResetRoleId`

`ResetTargetAppList`

`ResetTargetGroupList`

`IsConstruct`

`x`^Required

`IsTerraformElement`

`x`^Required

`IsTerraformResource`

`x`^Required

`GenerateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`TerraformMetaArguments`^Required

`TerraformResourceType`^Required

`TerraformGeneratorMetadata`^Optional

`Connection`^Optional

`Count`^Optional

`DependsOn`^Optional

`ForEach`^Optional

`Lifecycle`^Optional

`Provider`^Optional

`Provisioners`^Optional

`DisableNotificationsInput`^Optional

`GroupIdInput`^Optional