Represents a {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule okta_auth_server_policy_rule}.
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/authserverpolicyrule"
authserverpolicyrule.NewAuthServerPolicyRule(scope Construct, id *string, config AuthServerPolicyRuleConfig) AuthServerPolicyRule
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 |
AuthServerPolicyRuleConfig |
No description. |
- Type: github.com/aws/constructs-go/constructs/v10.Construct
The scope in which to define this construct.
- Type: *string
The scoped construct ID.
Must be unique amongst siblings in the same scope
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". |
ResetAccessTokenLifetimeMinutes |
No description. |
ResetGroupBlacklist |
No description. |
ResetGroupWhitelist |
No description. |
ResetId |
No description. |
ResetInlineHookId |
No description. |
ResetRefreshTokenLifetimeMinutes |
No description. |
ResetRefreshTokenWindowMinutes |
No description. |
ResetScopeWhitelist |
No description. |
ResetStatus |
No description. |
ResetType |
No description. |
ResetUserBlacklist |
No description. |
ResetUserWhitelist |
No description. |
func ToString() *string
Returns a string representation of this construct.
func AddOverride(path *string, value interface{})
- Type: *string
- Type: interface{}
func OverrideLogicalId(newLogicalId *string)
Overrides the auto-generated logical ID with a specific ID.
- Type: *string
The new logical ID to use for this stack element.
func ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
func ToHclTerraform() interface{}
func ToMetadata() interface{}
func ToTerraform() interface{}
Adds this resource to the terraform JSON output.
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.
- Type: *string
The string move target that will correspond to this resource.
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
- Type: *string
func GetBooleanAttribute(terraformAttribute *string) IResolvable
- Type: *string
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
- Type: *string
func GetListAttribute(terraformAttribute *string) *[]*string
- Type: *string
func GetNumberAttribute(terraformAttribute *string) *f64
- Type: *string
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
- Type: *string
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
- Type: *string
func GetStringAttribute(terraformAttribute *string) *string
- Type: *string
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
- Type: *string
func HasResourceMove() interface{}
func ImportFrom(id *string, provider TerraformProvider)
- Type: *string
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
func InterpolationForAttribute(terraformAttribute *string) IResolvable
- Type: *string
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.
- Type: *string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
func MoveTo(moveTarget *string, index interface{})
Moves this resource to the target resource given by moveTarget.
- Type: *string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: interface{}
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
func MoveToId(id *string)
Moves this resource to the resource corresponding to "id".
- Type: *string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
func ResetAccessTokenLifetimeMinutes()
func ResetGroupBlacklist()
func ResetGroupWhitelist()
func ResetId()
func ResetInlineHookId()
func ResetRefreshTokenLifetimeMinutes()
func ResetRefreshTokenWindowMinutes()
func ResetScopeWhitelist()
func ResetStatus()
func ResetType()
func ResetUserBlacklist()
func ResetUserWhitelist()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a AuthServerPolicyRule resource upon running "cdktf plan ". |
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/authserverpolicyrule"
authserverpolicyrule.AuthServerPolicyRule_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.
- Type: interface{}
Any object.
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/authserverpolicyrule"
authserverpolicyrule.AuthServerPolicyRule_IsTerraformElement(x interface{}) *bool
- Type: interface{}
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/authserverpolicyrule"
authserverpolicyrule.AuthServerPolicyRule_IsTerraformResource(x interface{}) *bool
- Type: interface{}
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/authserverpolicyrule"
authserverpolicyrule.AuthServerPolicyRule_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource
Generates CDKTF code for importing a AuthServerPolicyRule resource upon running "cdktf plan ".
- Type: github.com/aws/constructs-go/constructs/v10.Construct
The scope in which to define this construct.
- Type: *string
The construct id used in the generated config for the AuthServerPolicyRule to import.
- Type: *string
The id of the existing AuthServerPolicyRule that should be imported.
Refer to the {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#import import section} in the documentation of this resource for the id to use
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
? Optional instance of the provider where the AuthServerPolicyRule to import is found.
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. |
SystemAttribute |
github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable |
No description. |
AccessTokenLifetimeMinutesInput |
*f64 |
No description. |
AuthServerIdInput |
*string |
No description. |
GrantTypeWhitelistInput |
*[]*string |
No description. |
GroupBlacklistInput |
*[]*string |
No description. |
GroupWhitelistInput |
*[]*string |
No description. |
IdInput |
*string |
No description. |
InlineHookIdInput |
*string |
No description. |
NameInput |
*string |
No description. |
PolicyIdInput |
*string |
No description. |
PriorityInput |
*f64 |
No description. |
RefreshTokenLifetimeMinutesInput |
*f64 |
No description. |
RefreshTokenWindowMinutesInput |
*f64 |
No description. |
ScopeWhitelistInput |
*[]*string |
No description. |
StatusInput |
*string |
No description. |
TypeInput |
*string |
No description. |
UserBlacklistInput |
*[]*string |
No description. |
UserWhitelistInput |
*[]*string |
No description. |
AccessTokenLifetimeMinutes |
*f64 |
No description. |
AuthServerId |
*string |
No description. |
GrantTypeWhitelist |
*[]*string |
No description. |
GroupBlacklist |
*[]*string |
No description. |
GroupWhitelist |
*[]*string |
No description. |
Id |
*string |
No description. |
InlineHookId |
*string |
No description. |
Name |
*string |
No description. |
PolicyId |
*string |
No description. |
Priority |
*f64 |
No description. |
RefreshTokenLifetimeMinutes |
*f64 |
No description. |
RefreshTokenWindowMinutes |
*f64 |
No description. |
ScopeWhitelist |
*[]*string |
No description. |
Status |
*string |
No description. |
Type |
*string |
No description. |
UserBlacklist |
*[]*string |
No description. |
UserWhitelist |
*[]*string |
No description. |
func Node() Node
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
func CdktfStack() TerraformStack
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
func Fqn() *string
- Type: *string
func FriendlyUniqueId() *string
- Type: *string
func TerraformMetaArguments() *map[string]interface{}
- Type: *map[string]interface{}
func TerraformResourceType() *string
- Type: *string
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
func Connection() interface{}
- Type: interface{}
func Count() interface{}
- Type: interface{}
func DependsOn() *[]*string
- Type: *[]*string
func ForEach() ITerraformIterator
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
func Lifecycle() TerraformResourceLifecycle
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
func Provider() TerraformProvider
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
func Provisioners() *[]interface{}
- Type: *[]interface{}
func SystemAttribute() IResolvable
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable
func AccessTokenLifetimeMinutesInput() *f64
- Type: *f64
func AuthServerIdInput() *string
- Type: *string
func GrantTypeWhitelistInput() *[]*string
- Type: *[]*string
func GroupBlacklistInput() *[]*string
- Type: *[]*string
func GroupWhitelistInput() *[]*string
- Type: *[]*string
func IdInput() *string
- Type: *string
func InlineHookIdInput() *string
- Type: *string
func NameInput() *string
- Type: *string
func PolicyIdInput() *string
- Type: *string
func PriorityInput() *f64
- Type: *f64
func RefreshTokenLifetimeMinutesInput() *f64
- Type: *f64
func RefreshTokenWindowMinutesInput() *f64
- Type: *f64
func ScopeWhitelistInput() *[]*string
- Type: *[]*string
func StatusInput() *string
- Type: *string
func TypeInput() *string
- Type: *string
func UserBlacklistInput() *[]*string
- Type: *[]*string
func UserWhitelistInput() *[]*string
- Type: *[]*string
func AccessTokenLifetimeMinutes() *f64
- Type: *f64
func AuthServerId() *string
- Type: *string
func GrantTypeWhitelist() *[]*string
- Type: *[]*string
func GroupBlacklist() *[]*string
- Type: *[]*string
func GroupWhitelist() *[]*string
- Type: *[]*string
func Id() *string
- Type: *string
func InlineHookId() *string
- Type: *string
func Name() *string
- Type: *string
func PolicyId() *string
- Type: *string
func Priority() *f64
- Type: *f64
func RefreshTokenLifetimeMinutes() *f64
- Type: *f64
func RefreshTokenWindowMinutes() *f64
- Type: *f64
func ScopeWhitelist() *[]*string
- Type: *[]*string
func Status() *string
- Type: *string
func Type() *string
- Type: *string
func UserBlacklist() *[]*string
- Type: *[]*string
func UserWhitelist() *[]*string
- Type: *[]*string
Name | Type | Description |
---|---|---|
TfResourceType |
*string |
No description. |
func TfResourceType() *string
- Type: *string
import "github.com/cdktf/cdktf-provider-okta-go/okta/v13/authserverpolicyrule"
&authserverpolicyrule.AuthServerPolicyRuleConfig {
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{},
AuthServerId: *string,
GrantTypeWhitelist: *[]*string,
Name: *string,
PolicyId: *string,
Priority: *f64,
AccessTokenLifetimeMinutes: *f64,
GroupBlacklist: *[]*string,
GroupWhitelist: *[]*string,
Id: *string,
InlineHookId: *string,
RefreshTokenLifetimeMinutes: *f64,
RefreshTokenWindowMinutes: *f64,
ScopeWhitelist: *[]*string,
Status: *string,
Type: *string,
UserBlacklist: *[]*string,
UserWhitelist: *[]*string,
}
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. |
AuthServerId |
*string |
Auth server ID. |
GrantTypeWhitelist |
*[]*string |
Accepted grant type values, authorization_code , implicit , password , client_credentials , urn:ietf:params:oauth:grant-type:saml2-bearer (Early Access Property), urn:ietf:params:oauth:grant-type:token-exchange (Early Access Property),urn:ietf:params:oauth:grant-type:device_code (Early Access Property), interaction_code (OIE only). |
Name |
*string |
Auth server policy rule name. |
PolicyId |
*string |
Auth server policy ID. |
Priority |
*f64 |
Priority of the auth server policy rule. |
AccessTokenLifetimeMinutes |
*f64 |
Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is 60 . |
GroupBlacklist |
*[]*string |
Specifies a set of Groups whose Users are to be excluded. |
GroupWhitelist |
*[]*string |
Specifies a set of Groups whose Users are to be included. |
Id |
*string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#id AuthServerPolicyRule#id}. |
InlineHookId |
*string |
The ID of the inline token to trigger. |
RefreshTokenLifetimeMinutes |
*f64 |
Lifetime of refresh token. |
RefreshTokenWindowMinutes |
*f64 |
Window in which a refresh token can be used. |
ScopeWhitelist |
*[]*string |
Scopes allowed for this policy rule. |
Status |
*string |
Default to ACTIVE . |
Type |
*string |
Auth server policy rule type, unlikely this will be anything other then the default. |
UserBlacklist |
*[]*string |
Specifies a set of Users to be excluded. |
UserWhitelist |
*[]*string |
Specifies a set of Users to be included. |
Connection interface{}
- Type: interface{}
Count interface{}
- Type: interface{}
DependsOn *[]ITerraformDependable
- Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEach ITerraformIterator
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
Lifecycle TerraformResourceLifecycle
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
Provider TerraformProvider
- Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
Provisioners *[]interface{}
- Type: *[]interface{}
AuthServerId *string
- Type: *string
Auth server ID.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#auth_server_id AuthServerPolicyRule#auth_server_id}
GrantTypeWhitelist *[]*string
- Type: *[]*string
Accepted grant type values, authorization_code
, implicit
, password
, client_credentials
, urn:ietf:params:oauth:grant-type:saml2-bearer
(Early Access Property), urn:ietf:params:oauth:grant-type:token-exchange
(Early Access Property),urn:ietf:params:oauth:grant-type:device_code
(Early Access Property), interaction_code
(OIE only).
For implicit
value either user_whitelist
or group_whitelist
should be set.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#grant_type_whitelist AuthServerPolicyRule#grant_type_whitelist}
Name *string
- Type: *string
Auth server policy rule name.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#name AuthServerPolicyRule#name}
PolicyId *string
- Type: *string
Auth server policy ID.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#policy_id AuthServerPolicyRule#policy_id}
Priority *f64
- Type: *f64
Priority of the auth server policy rule.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#priority AuthServerPolicyRule#priority}
AccessTokenLifetimeMinutes *f64
- Type: *f64
Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is 60
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#access_token_lifetime_minutes AuthServerPolicyRule#access_token_lifetime_minutes}
GroupBlacklist *[]*string
- Type: *[]*string
Specifies a set of Groups whose Users are to be excluded.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#group_blacklist AuthServerPolicyRule#group_blacklist}
GroupWhitelist *[]*string
- Type: *[]*string
Specifies a set of Groups whose Users are to be included.
Can be set to Group ID or to the following: EVERYONE
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#group_whitelist AuthServerPolicyRule#group_whitelist}
Id *string
- Type: *string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#id AuthServerPolicyRule#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.
InlineHookId *string
- Type: *string
The ID of the inline token to trigger.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#inline_hook_id AuthServerPolicyRule#inline_hook_id}
RefreshTokenLifetimeMinutes *f64
- Type: *f64
Lifetime of refresh token.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#refresh_token_lifetime_minutes AuthServerPolicyRule#refresh_token_lifetime_minutes}
RefreshTokenWindowMinutes *f64
- Type: *f64
Window in which a refresh token can be used.
It can be a value between 5 and 2628000 (5 years) minutes. Default is 10080
(7 days).refresh_token_window_minutes
must be between access_token_lifetime_minutes
and refresh_token_lifetime_minutes
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#refresh_token_window_minutes AuthServerPolicyRule#refresh_token_window_minutes}
ScopeWhitelist *[]*string
- Type: *[]*string
Scopes allowed for this policy rule.
They can be whitelisted by name or all can be whitelisted with *
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#scope_whitelist AuthServerPolicyRule#scope_whitelist}
Status *string
- Type: *string
Default to ACTIVE
.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#status AuthServerPolicyRule#status}
Type *string
- Type: *string
Auth server policy rule type, unlikely this will be anything other then the default.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#type AuthServerPolicyRule#type}
UserBlacklist *[]*string
- Type: *[]*string
Specifies a set of Users to be excluded.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#user_blacklist AuthServerPolicyRule#user_blacklist}
UserWhitelist *[]*string
- Type: *[]*string
Specifies a set of Users to be included.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/okta/okta/4.14.0/docs/resources/auth_server_policy_rule#user_whitelist AuthServerPolicyRule#user_whitelist}