dataoktagroups

README

data_okta_groups

Refer to the Terraform Registory for docs: data_okta_groups.

Documentation

Index

• func DataOktaGroups_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
• func DataOktaGroups_IsConstruct(x interface{}) *bool
• func DataOktaGroups_IsTerraformDataSource(x interface{}) *bool
• func DataOktaGroups_IsTerraformElement(x interface{}) *bool
• func DataOktaGroups_TfResourceType() *string
• func NewDataOktaGroupsGroupsList_Override(d DataOktaGroupsGroupsList, terraformResource cdktf.IInterpolatingParent, ...)
• func NewDataOktaGroupsGroupsOutputReference_Override(d DataOktaGroupsGroupsOutputReference, ...)
• func NewDataOktaGroups_Override(d DataOktaGroups, scope constructs.Construct, id *string, ...)
• type DataOktaGroups
  • func NewDataOktaGroups(scope constructs.Construct, id *string, config *DataOktaGroupsConfig) DataOktaGroups
• type DataOktaGroupsConfig
• type DataOktaGroupsGroups
• type DataOktaGroupsGroupsList
  • func NewDataOktaGroupsGroupsList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, ...) DataOktaGroupsGroupsList
• type DataOktaGroupsGroupsOutputReference
  • func NewDataOktaGroupsGroupsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, ...) DataOktaGroupsGroupsOutputReference

Functions

func DataOktaGroups_GenerateConfigForImport

func DataOktaGroups_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a DataOktaGroups resource upon running "cdktf plan <stack-name>".

func DataOktaGroups_IsConstruct

func DataOktaGroups_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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func DataOktaGroups_IsTerraformDataSource

func DataOktaGroups_IsTerraformDataSource(x interface{}) *bool

Experimental.

func DataOktaGroups_IsTerraformElement

func DataOktaGroups_IsTerraformElement(x interface{}) *bool

Experimental.

func DataOktaGroups_TfResourceType

func DataOktaGroups_TfResourceType() *string

func NewDataOktaGroupsGroupsList_Override

func NewDataOktaGroupsGroupsList_Override(d DataOktaGroupsGroupsList, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool)

func NewDataOktaGroupsGroupsOutputReference_Override

func NewDataOktaGroupsGroupsOutputReference_Override(d DataOktaGroupsGroupsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool)

func NewDataOktaGroups_Override

func NewDataOktaGroups_Override(d DataOktaGroups, scope constructs.Construct, id *string, config *DataOktaGroupsConfig)

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/groups okta_groups} Data Source.

Types

type DataOktaGroups

type DataOktaGroups interface {
	cdktf.TerraformDataSource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Groups() DataOktaGroupsGroupsList
	Id() *string
	SetId(val *string)
	IdInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	Q() *string
	SetQ(val *string)
	QInput() *string
	// Experimental.
	RawOverrides() interface{}
	Search() *string
	SetSearch(val *string)
	SearchInput() *string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	Type() *string
	SetType(val *string)
	TypeInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetId()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetQ()
	ResetSearch()
	ResetType()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/groups okta_groups}.

func NewDataOktaGroups

func NewDataOktaGroups(scope constructs.Construct, id *string, config *DataOktaGroupsConfig) DataOktaGroups

Create a new {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/groups okta_groups} Data Source.

type DataOktaGroupsConfig

type DataOktaGroupsConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/groups#id DataOktaGroups#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.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// Searches the name property of groups for matching value.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/groups#q DataOktaGroups#q}
	Q *string `field:"optional" json:"q" yaml:"q"`
	// Searches for groups with a supported filtering expression for all attributes except for '_embedded', '_links', and 'objectClass'.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/groups#search DataOktaGroups#search}
	Search *string `field:"optional" json:"search" yaml:"search"`
	// Type of the group.
	//
	// When specified in the terraform resource, will act as a filter when searching for the groups
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.5.0/docs/data-sources/groups#type DataOktaGroups#type}
	Type *string `field:"optional" json:"type" yaml:"type"`
}

type DataOktaGroupsGroups

type DataOktaGroupsGroups struct {
}

type DataOktaGroupsGroupsList

type DataOktaGroupsGroupsList interface {
	cdktf.ComplexList
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	// The attribute on the parent resource this class is referencing.
	TerraformAttribute() *string
	SetTerraformAttribute(val *string)
	// The parent resource.
	TerraformResource() cdktf.IInterpolatingParent
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
	WrapsSet() *bool
	SetWrapsSet(val *bool)
	// Experimental.
	ComputeFqn() *string
	Get(index *float64) DataOktaGroupsGroupsOutputReference
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataOktaGroupsGroupsList

func NewDataOktaGroupsGroupsList(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DataOktaGroupsGroupsList

type DataOktaGroupsGroupsOutputReference

type DataOktaGroupsGroupsOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	CustomProfileAttributes() *string
	Description() *string
	// Experimental.
	Fqn() *string
	Id() *string
	InternalValue() *DataOktaGroupsGroups
	SetInternalValue(val *DataOktaGroupsGroups)
	Name() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	Type() *string
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewDataOktaGroupsGroupsOutputReference

func NewDataOktaGroupsGroupsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string, complexObjectIndex *float64, complexObjectIsFromSet *bool) DataOktaGroupsGroupsOutputReference