Skip to content

Latest commit

 

History

History
1997 lines (1247 loc) · 74.8 KB

dataOktaUser.go.md

File metadata and controls

1997 lines (1247 loc) · 74.8 KB
Raw

dataOktaUser Submodule

Constructs

DataOktaUser

Represents a {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user okta_user}.

Initializers 

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

dataoktauser.NewDataOktaUser(scope Construct, id *string, config DataOktaUserConfig) DataOktaUser
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 DataOktaUserConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configOptional

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 Adds this resource to the terraform JSON output.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
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.
InterpolationForAttribute No description.
PutSearch No description.
ResetCompoundSearchOperator No description.
ResetDelayReadSeconds No description.
ResetId No description.
ResetSearch No description.
ResetSkipGroups No description.
ResetSkipRoles No description.
ResetUserId No description.
ToString 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • 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{}

Adds this resource to the terraform JSON output.

ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
PutSearch 
func PutSearch(value interface{})
valueRequired
  • Type: interface{}
ResetCompoundSearchOperator 
func ResetCompoundSearchOperator()
ResetDelayReadSeconds 
func ResetDelayReadSeconds()
ResetId 
func ResetId()
ResetSearch 
func ResetSearch()
ResetSkipGroups 
func ResetSkipGroups()
ResetSkipRoles 
func ResetSkipRoles()
ResetUserId 
func ResetUserId()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformDataSource No description.
GenerateConfigForImport Generates CDKTF code for importing a DataOktaUser resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/dataoktauser"

dataoktauser.DataOktaUser_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.

xRequired
  • Type: interface{}

Any object.

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

dataoktauser.DataOktaUser_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformDataSource 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/dataoktauser"

dataoktauser.DataOktaUser_IsTerraformDataSource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/dataoktauser"

dataoktauser.DataOktaUser_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

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

The scope in which to define this construct.

importToIdRequired
  • Type: *string

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

importFromIdRequired
  • Type: *string

The id of the existing DataOktaUser that should be imported.

Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#import import section} in the documentation of this resource for the id to use

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

? Optional instance of the provider where the DataOktaUser 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.
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.
AdminRoles *[]*string No description.
City *string No description.
CostCenter *string No description.
CountryCode *string No description.
CustomProfileAttributes *string No description.
Department *string No description.
DisplayName *string No description.
Division *string No description.
Email *string No description.
EmployeeNumber *string No description.
FirstName *string No description.
GroupMemberships *[]*string No description.
HonorificPrefix *string No description.
HonorificSuffix *string No description.
LastName *string No description.
Locale *string No description.
Login *string No description.
Manager *string No description.
ManagerId *string No description.
MiddleName *string No description.
MobilePhone *string No description.
NickName *string No description.
Organization *string No description.
PostalAddress *string No description.
PreferredLanguage *string No description.
PrimaryPhone *string No description.
ProfileUrl *string No description.
Roles *[]*string No description.
Search DataOktaUserSearchList No description.
SecondEmail *string No description.
State *string No description.
Status *string No description.
StreetAddress *string No description.
Timezone *string No description.
Title *string No description.
UserType *string No description.
ZipCode *string No description.
CompoundSearchOperatorInput *string No description.
DelayReadSecondsInput *string No description.
IdInput *string No description.
SearchInput interface{} No description.
SkipGroupsInput interface{} No description.
SkipRolesInput interface{} No description.
UserIdInput *string No description.
CompoundSearchOperator *string No description.
DelayReadSeconds *string No description.
Id *string No description.
SkipGroups interface{} No description.
SkipRoles interface{} No description.
UserId *string No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
AdminRolesRequired 
func AdminRoles() *[]*string
  • Type: *[]*string
CityRequired 
func City() *string
  • Type: *string
CostCenterRequired 
func CostCenter() *string
  • Type: *string
CountryCodeRequired 
func CountryCode() *string
  • Type: *string
CustomProfileAttributesRequired 
func CustomProfileAttributes() *string
  • Type: *string
DepartmentRequired 
func Department() *string
  • Type: *string
DisplayNameRequired 
func DisplayName() *string
  • Type: *string
DivisionRequired 
func Division() *string
  • Type: *string
EmailRequired 
func Email() *string
  • Type: *string
EmployeeNumberRequired 
func EmployeeNumber() *string
  • Type: *string
FirstNameRequired 
func FirstName() *string
  • Type: *string
GroupMembershipsRequired 
func GroupMemberships() *[]*string
  • Type: *[]*string
HonorificPrefixRequired 
func HonorificPrefix() *string
  • Type: *string
HonorificSuffixRequired 
func HonorificSuffix() *string
  • Type: *string
LastNameRequired 
func LastName() *string
  • Type: *string
LocaleRequired 
func Locale() *string
  • Type: *string
LoginRequired 
func Login() *string
  • Type: *string
ManagerRequired 
func Manager() *string
  • Type: *string
ManagerIdRequired 
func ManagerId() *string
  • Type: *string
MiddleNameRequired 
func MiddleName() *string
  • Type: *string
MobilePhoneRequired 
func MobilePhone() *string
  • Type: *string
NickNameRequired 
func NickName() *string
  • Type: *string
OrganizationRequired 
func Organization() *string
  • Type: *string
PostalAddressRequired 
func PostalAddress() *string
  • Type: *string
PreferredLanguageRequired 
func PreferredLanguage() *string
  • Type: *string
PrimaryPhoneRequired 
func PrimaryPhone() *string
  • Type: *string
ProfileUrlRequired 
func ProfileUrl() *string
  • Type: *string
RolesRequired 
func Roles() *[]*string
  • Type: *[]*string
SearchRequired 
func Search() DataOktaUserSearchList
SecondEmailRequired 
func SecondEmail() *string
  • Type: *string
StateRequired 
func State() *string
  • Type: *string
StatusRequired 
func Status() *string
  • Type: *string
StreetAddressRequired 
func StreetAddress() *string
  • Type: *string
TimezoneRequired 
func Timezone() *string
  • Type: *string
TitleRequired 
func Title() *string
  • Type: *string
UserTypeRequired 
func UserType() *string
  • Type: *string
ZipCodeRequired 
func ZipCode() *string
  • Type: *string
CompoundSearchOperatorInputOptional 
func CompoundSearchOperatorInput() *string
  • Type: *string
DelayReadSecondsInputOptional 
func DelayReadSecondsInput() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
SearchInputOptional 
func SearchInput() interface{}
  • Type: interface{}
SkipGroupsInputOptional 
func SkipGroupsInput() interface{}
  • Type: interface{}
SkipRolesInputOptional 
func SkipRolesInput() interface{}
  • Type: interface{}
UserIdInputOptional 
func UserIdInput() *string
  • Type: *string
CompoundSearchOperatorRequired 
func CompoundSearchOperator() *string
  • Type: *string
DelayReadSecondsRequired 
func DelayReadSeconds() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
SkipGroupsRequired 
func SkipGroups() interface{}
  • Type: interface{}
SkipRolesRequired 
func SkipRoles() interface{}
  • Type: interface{}
UserIdRequired 
func UserId() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

DataOktaUserConfig

Initializer 

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

&dataoktauser.DataOktaUserConfig {
	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{},
	CompoundSearchOperator: *string,
	DelayReadSeconds: *string,
	Id: *string,
	Search: interface{},
	SkipGroups: interface{},
	SkipRoles: interface{},
	UserId: *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.
CompoundSearchOperator *string Search operator used when joining multiple search clauses.
DelayReadSeconds *string Force delay of the user read by N seconds.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#id DataOktaUser#id}.
Search interface{} search block.
SkipGroups interface{} Do not populate user groups information (prevents additional API call).
SkipRoles interface{} Do not populate user roles information (prevents additional API call).
UserId *string Retrieve a single user based on their id.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
CompoundSearchOperatorOptional 
CompoundSearchOperator *string
  • Type: *string

Search operator used when joining multiple search clauses.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#compound_search_operator DataOktaUser#compound_search_operator}

DelayReadSecondsOptional 
DelayReadSeconds *string
  • Type: *string

Force delay of the user read by N seconds.

Useful when eventual consistency of user information needs to be allowed for.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#delay_read_seconds DataOktaUser#delay_read_seconds}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#id DataOktaUser#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.

SearchOptional 
Search interface{}
  • Type: interface{}

search block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#search DataOktaUser#search}

SkipGroupsOptional 
SkipGroups interface{}
  • Type: interface{}

Do not populate user groups information (prevents additional API call).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#skip_groups DataOktaUser#skip_groups}

SkipRolesOptional 
SkipRoles interface{}
  • Type: interface{}

Do not populate user roles information (prevents additional API call).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#skip_roles DataOktaUser#skip_roles}

UserIdOptional 
UserId *string
  • Type: *string

Retrieve a single user based on their id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#user_id DataOktaUser#user_id}

DataOktaUserSearch

Initializer 

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

&dataoktauser.DataOktaUserSearch {
	Comparison: *string,
	Expression: *string,
	Name: *string,
	Value: *string,
}

Properties

Name Type Description
Comparison *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#comparison DataOktaUser#comparison}.
Expression *string A raw search expression string.
Name *string Property name to search for.
Value *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#value DataOktaUser#value}.
ComparisonOptional 
Comparison *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#comparison DataOktaUser#comparison}.

ExpressionOptional 
Expression *string
  • Type: *string

A raw search expression string.

This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#expression DataOktaUser#expression}

NameOptional 
Name *string
  • Type: *string

Property name to search for.

This requires the search feature be on. Please see Okta documentation on their filter API for users. https://developer.okta.com/docs/api/resources/users#list-users-with-search

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#name DataOktaUser#name}

ValueOptional 
Value *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.12.0/docs/data-sources/user#value DataOktaUser#value}.

Classes

DataOktaUserSearchList

Initializers 

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

dataoktauser.NewDataOktaUserSearchList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DataOktaUserSearchList
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
wrapsSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.
AllWithMapKey 
func AllWithMapKey(mapKeyAttributeName *string) DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: *string
ComputeFqn 
func ComputeFqn() *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
func Get(index *f64) DataOktaUserSearchOutputReference
indexRequired
  • Type: *f64

the index of the item to return.

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
InternalValue interface{} No description.
CreationStackRequired 
func CreationStack() *[]*string
  • Type: *[]*string

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.

FqnRequired 
func Fqn() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}

DataOktaUserSearchOutputReference

Initializers 

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

dataoktauser.NewDataOktaUserSearchOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) DataOktaUserSearchOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
complexObjectIndex *f64 the index of this item in the list.
complexObjectIsFromSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: *f64

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: *bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
ComputeFqn No description.
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.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetComparison No description.
ResetExpression No description.
ResetName No description.
ResetValue No description.
ComputeFqn 
func ComputeFqn() *string
GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetComparison 
func ResetComparison()
ResetExpression 
func ResetExpression()
ResetName 
func ResetName()
ResetValue 
func ResetValue()

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
ComparisonInput *string No description.
ExpressionInput *string No description.
NameInput *string No description.
ValueInput *string No description.
Comparison *string No description.
Expression *string No description.
Name *string No description.
Value *string No description.
InternalValue interface{} No description.
CreationStackRequired 
func CreationStack() *[]*string
  • Type: *[]*string

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.

FqnRequired 
func Fqn() *string
  • Type: *string
ComparisonInputOptional 
func ComparisonInput() *string
  • Type: *string
ExpressionInputOptional 
func ExpressionInput() *string
  • Type: *string
NameInputOptional 
func NameInput() *string
  • Type: *string
ValueInputOptional 
func ValueInput() *string
  • Type: *string
ComparisonRequired 
func Comparison() *string
  • Type: *string
ExpressionRequired 
func Expression() *string
  • Type: *string
NameRequired 
func Name() *string
  • Type: *string
ValueRequired 
func Value() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}