`opensearchserverlessSecurityConfig` Submodule

Constructs

OpensearchserverlessSecurityConfig

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config aws_opensearchserverless_security_config}.

Initializers

import io.cdktn.providers.aws.opensearchserverless_security_config.OpensearchserverlessSecurityConfig;

OpensearchserverlessSecurityConfig.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .name(java.lang.String)
    .type(java.lang.String)
//  .description(java.lang.String)
//  .region(java.lang.String)
//  .samlOptions(IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>)
    .build();

Name	Type	Description
`scope`	`software.constructs.Construct`	The scope in which to define this construct.
`id`	`java.lang.String`	The scoped construct ID.
`connection`	`io.cdktn.cdktn.SSHProvisionerConnection\|io.cdktn.cdktn.WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number\|io.cdktn.cdktn.TerraformCount`	No description.
`dependsOn`	`java.util.List<io.cdktn.cdktn.ITerraformDependable>`	No description.
`forEach`	`io.cdktn.cdktn.ITerraformIterator`	No description.
`lifecycle`	`io.cdktn.cdktn.TerraformResourceLifecycle`	No description.
`provider`	`io.cdktn.cdktn.TerraformProvider`	No description.
`provisioners`	`java.util.List<io.cdktn.cdktn.FileProvisioner\|io.cdktn.cdktn.LocalExecProvisioner\|io.cdktn.cdktn.RemoteExecProvisioner>`	No description.
`name`	`java.lang.String`	Name of the policy.
`type`	`java.lang.String`	Type of configuration. Must be `saml`.
`description`	`java.lang.String`	Description of the security configuration.
`region`	`java.lang.String`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`samlOptions`	`io.cdktn.cdktn.IResolvable\|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>`	saml_options block.

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection

`count`^Optional

Type: java.lang.Number|io.cdktn.cdktn.TerraformCount

`dependsOn`^Optional

Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>

`forEach`^Optional

Type: io.cdktn.cdktn.ITerraformIterator

`lifecycle`^Optional

Type: io.cdktn.cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: io.cdktn.cdktn.TerraformProvider

`provisioners`^Optional

Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>

`name`^Required

Type: java.lang.String

Name of the policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#name OpensearchserverlessSecurityConfig#name}

`type`^Required

Type: java.lang.String

Type of configuration. Must be saml.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#type OpensearchserverlessSecurityConfig#type}

`description`^Optional

Type: java.lang.String

Description of the security configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#description OpensearchserverlessSecurityConfig#description}

`region`^Optional

Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#region OpensearchserverlessSecurityConfig#region}

`samlOptions`^Optional

Type: io.cdktn.cdktn.IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>

saml_options block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#saml_options OpensearchserverlessSecurityConfig#saml_options}

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to 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".
`putSamlOptions`	No description.
`resetDescription`	No description.
`resetRegion`	No description.
`resetSamlOptions`	No description.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`with`

public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: software.constructs.IMixin...

The mixins to apply.

`addOverride`

public void addOverride(java.lang.String path, java.lang.Object value)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

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

`newLogicalId`^Required

Type: java.lang.String

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public void resetOverrideLogicalId()

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

`toHclTerraform`

public java.lang.Object toHclTerraform()

`toMetadata`

public java.lang.Object toMetadata()

`toTerraform`

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

`addMoveTarget`

public void addMoveTarget(java.lang.String moveTarget)

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: java.lang.String

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`hasResourceMove`

public TerraformResourceMoveByTarget|TerraformResourceMoveById hasResourceMove()

`importFrom`

public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)

`id`^Required

Type: java.lang.String

`provider`^Optional

Type: io.cdktn.cdktn.TerraformProvider

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`moveFromId`

public void moveFromId(java.lang.String id)

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: java.lang.String

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

`moveTo`

public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String|java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: java.lang.String

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

`index`^Optional

Type: java.lang.String|java.lang.Number

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

`moveToId`

public void moveToId(java.lang.String id)

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

`id`^Required

Type: java.lang.String

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

`putSamlOptions`

public void putSamlOptions(IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions> value)

`value`^Required

Type: io.cdktn.cdktn.IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>

`resetDescription`

public void resetDescription()

`resetRegion`

public void resetRegion()

`resetSamlOptions`

public void resetSamlOptions()

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTN code for importing a OpensearchserverlessSecurityConfig resource upon running "cdktn plan ".

`isConstruct`

import io.cdktn.providers.aws.opensearchserverless_security_config.OpensearchserverlessSecurityConfig;

OpensearchserverlessSecurityConfig.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

`isTerraformElement`

import io.cdktn.providers.aws.opensearchserverless_security_config.OpensearchserverlessSecurityConfig;

OpensearchserverlessSecurityConfig.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformResource`

import io.cdktn.providers.aws.opensearchserverless_security_config.OpensearchserverlessSecurityConfig;

OpensearchserverlessSecurityConfig.isTerraformResource(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`generateConfigForImport`

import io.cdktn.providers.aws.opensearchserverless_security_config.OpensearchserverlessSecurityConfig;

OpensearchserverlessSecurityConfig.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OpensearchserverlessSecurityConfig.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTN code for importing a OpensearchserverlessSecurityConfig resource upon running "cdktn plan ".

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: java.lang.String

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

`importFromId`^Required

Type: java.lang.String

The id of the existing OpensearchserverlessSecurityConfig that should be imported.

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

`provider`^Optional

Type: io.cdktn.cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`software.constructs.Node`	The tree node.
`cdktfStack`	`io.cdktn.cdktn.TerraformStack`	No description.
`fqn`	`java.lang.String`	No description.
`friendlyUniqueId`	`java.lang.String`	No description.
`terraformMetaArguments`	`java.util.Map<java.lang.String, java.lang.Object>`	No description.
`terraformResourceType`	`java.lang.String`	No description.
`terraformGeneratorMetadata`	`io.cdktn.cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`io.cdktn.cdktn.SSHProvisionerConnection\|io.cdktn.cdktn.WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number\|io.cdktn.cdktn.TerraformCount`	No description.
`dependsOn`	`java.util.List<java.lang.String>`	No description.
`forEach`	`io.cdktn.cdktn.ITerraformIterator`	No description.
`lifecycle`	`io.cdktn.cdktn.TerraformResourceLifecycle`	No description.
`provider`	`io.cdktn.cdktn.TerraformProvider`	No description.
`provisioners`	`java.util.List<io.cdktn.cdktn.FileProvisioner\|io.cdktn.cdktn.LocalExecProvisioner\|io.cdktn.cdktn.RemoteExecProvisioner>`	No description.
`configVersion`	`java.lang.String`	No description.
`id`	`java.lang.String`	No description.
`samlOptions`	`OpensearchserverlessSecurityConfigSamlOptionsList`	No description.
`descriptionInput`	`java.lang.String`	No description.
`nameInput`	`java.lang.String`	No description.
`regionInput`	`java.lang.String`	No description.
`samlOptionsInput`	`io.cdktn.cdktn.IResolvable\|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>`	No description.
`typeInput`	`java.lang.String`	No description.
`description`	`java.lang.String`	No description.
`name`	`java.lang.String`	No description.
`region`	`java.lang.String`	No description.
`type`	`java.lang.String`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: io.cdktn.cdktn.TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

`terraformMetaArguments`^Required

public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();

Type: java.util.Map<java.lang.String, java.lang.Object>

`terraformResourceType`^Required

public java.lang.String getTerraformResourceType();

Type: java.lang.String

`terraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();

Type: io.cdktn.cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();

Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection

`count`^Optional

public java.lang.Number|TerraformCount getCount();

Type: java.lang.Number|io.cdktn.cdktn.TerraformCount

`dependsOn`^Optional

public java.util.List<java.lang.String> getDependsOn();

Type: java.util.List<java.lang.String>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: io.cdktn.cdktn.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: io.cdktn.cdktn.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: io.cdktn.cdktn.TerraformProvider

`provisioners`^Optional

public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();

Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>

`configVersion`^Required

public java.lang.String getConfigVersion();

Type: java.lang.String

`id`^Required

public java.lang.String getId();

Type: java.lang.String

`samlOptions`^Required

public OpensearchserverlessSecurityConfigSamlOptionsList getSamlOptions();

Type: OpensearchserverlessSecurityConfigSamlOptionsList

`descriptionInput`^Optional

public java.lang.String getDescriptionInput();

Type: java.lang.String

`nameInput`^Optional

public java.lang.String getNameInput();

Type: java.lang.String

`regionInput`^Optional

public java.lang.String getRegionInput();

Type: java.lang.String

`samlOptionsInput`^Optional

public IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions> getSamlOptionsInput();

Type: io.cdktn.cdktn.IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>

`typeInput`^Optional

public java.lang.String getTypeInput();

Type: java.lang.String

`description`^Required

public java.lang.String getDescription();

Type: java.lang.String

`name`^Required

public java.lang.String getName();

Type: java.lang.String

`region`^Required

public java.lang.String getRegion();

Type: java.lang.String

`type`^Required

public java.lang.String getType();

Type: java.lang.String

Constants

Name	Type	Description
`tfResourceType`	`java.lang.String`	No description.

`tfResourceType`^Required

public java.lang.String getTfResourceType();

Type: java.lang.String

Structs

OpensearchserverlessSecurityConfigConfig

Initializer

import io.cdktn.providers.aws.opensearchserverless_security_config.OpensearchserverlessSecurityConfigConfig;

OpensearchserverlessSecurityConfigConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .name(java.lang.String)
    .type(java.lang.String)
//  .description(java.lang.String)
//  .region(java.lang.String)
//  .samlOptions(IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>)
    .build();

Properties

Name	Type	Description
`connection`	`io.cdktn.cdktn.SSHProvisionerConnection\|io.cdktn.cdktn.WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number\|io.cdktn.cdktn.TerraformCount`	No description.
`dependsOn`	`java.util.List<io.cdktn.cdktn.ITerraformDependable>`	No description.
`forEach`	`io.cdktn.cdktn.ITerraformIterator`	No description.
`lifecycle`	`io.cdktn.cdktn.TerraformResourceLifecycle`	No description.
`provider`	`io.cdktn.cdktn.TerraformProvider`	No description.
`provisioners`	`java.util.List<io.cdktn.cdktn.FileProvisioner\|io.cdktn.cdktn.LocalExecProvisioner\|io.cdktn.cdktn.RemoteExecProvisioner>`	No description.
`name`	`java.lang.String`	Name of the policy.
`type`	`java.lang.String`	Type of configuration. Must be `saml`.
`description`	`java.lang.String`	Description of the security configuration.
`region`	`java.lang.String`	Region where this resource will be managed. Defaults to the Region set in the provider configuration.
`samlOptions`	`io.cdktn.cdktn.IResolvable\|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>`	saml_options block.

`connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();

Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection

`count`^Optional

public java.lang.Number|TerraformCount getCount();

Type: java.lang.Number|io.cdktn.cdktn.TerraformCount

`dependsOn`^Optional

public java.util.List<ITerraformDependable> getDependsOn();

Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: io.cdktn.cdktn.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: io.cdktn.cdktn.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: io.cdktn.cdktn.TerraformProvider

`provisioners`^Optional

public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();

Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>

`name`^Required

public java.lang.String getName();

Type: java.lang.String

Name of the policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#name OpensearchserverlessSecurityConfig#name}

`type`^Required

public java.lang.String getType();

Type: java.lang.String

Type of configuration. Must be saml.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#type OpensearchserverlessSecurityConfig#type}

`description`^Optional

public java.lang.String getDescription();

Type: java.lang.String

Description of the security configuration.

`region`^Optional

public java.lang.String getRegion();

Type: java.lang.String

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#region OpensearchserverlessSecurityConfig#region}

`samlOptions`^Optional

public IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions> getSamlOptions();

Type: io.cdktn.cdktn.IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>

saml_options block.

OpensearchserverlessSecurityConfigSamlOptions

Initializer

import io.cdktn.providers.aws.opensearchserverless_security_config.OpensearchserverlessSecurityConfigSamlOptions;

OpensearchserverlessSecurityConfigSamlOptions.builder()
    .metadata(java.lang.String)
//  .groupAttribute(java.lang.String)
//  .sessionTimeout(java.lang.Number)
//  .userAttribute(java.lang.String)
    .build();

Properties

Name	Type	Description
`metadata`	`java.lang.String`	The XML IdP metadata file generated from your identity provider.
`groupAttribute`	`java.lang.String`	Group attribute for this SAML integration.
`sessionTimeout`	`java.lang.Number`	Session timeout, in minutes. Minimum is 5 minutes and maximum is 720 minutes (12 hours). Default is 60 minutes.
`userAttribute`	`java.lang.String`	User attribute for this SAML integration.

`metadata`^Required

public java.lang.String getMetadata();

Type: java.lang.String

The XML IdP metadata file generated from your identity provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#metadata OpensearchserverlessSecurityConfig#metadata}

`groupAttribute`^Optional

public java.lang.String getGroupAttribute();

Type: java.lang.String

Group attribute for this SAML integration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#group_attribute OpensearchserverlessSecurityConfig#group_attribute}

`sessionTimeout`^Optional

public java.lang.Number getSessionTimeout();

Type: java.lang.Number

Session timeout, in minutes. Minimum is 5 minutes and maximum is 720 minutes (12 hours). Default is 60 minutes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#session_timeout OpensearchserverlessSecurityConfig#session_timeout}

`userAttribute`^Optional

public java.lang.String getUserAttribute();

Type: java.lang.String

User attribute for this SAML integration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/opensearchserverless_security_config#user_attribute OpensearchserverlessSecurityConfig#user_attribute}

Classes

OpensearchserverlessSecurityConfigSamlOptionsList

Initializers

import io.cdktn.providers.aws.opensearchserverless_security_config.OpensearchserverlessSecurityConfigSamlOptionsList;

new OpensearchserverlessSecurityConfigSamlOptionsList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);

Name	Type	Description
`terraformResource`	`io.cdktn.cdktn.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`java.lang.String`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`java.lang.Boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: io.cdktn.cdktn.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: java.lang.String

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: java.lang.Boolean

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`

public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

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

`mapKeyAttributeName`^Required

Type: java.lang.String

`computeFqn`

public java.lang.String computeFqn()

`resolve`

public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

`_context`^Required

Type: io.cdktn.cdktn.IResolveContext

`toString`

public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public OpensearchserverlessSecurityConfigSamlOptionsOutputReference get(java.lang.Number index)

`index`^Required

Type: java.lang.Number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`java.util.List<java.lang.String>`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`java.lang.String`	No description.
`internalValue`	`io.cdktn.cdktn.IResolvable\|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>`	No description.

`creationStack`^Required

public java.util.List<java.lang.String> getCreationStack();

Type: java.util.List<java.lang.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.

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`internalValue`^Optional

public IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions> getInternalValue();

Type: io.cdktn.cdktn.IResolvable|java.util.List<OpensearchserverlessSecurityConfigSamlOptions>

OpensearchserverlessSecurityConfigSamlOptionsOutputReference

Initializers

import io.cdktn.providers.aws.opensearchserverless_security_config.OpensearchserverlessSecurityConfigSamlOptionsOutputReference;

new OpensearchserverlessSecurityConfigSamlOptionsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);

Name	Type	Description
`terraformResource`	`io.cdktn.cdktn.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`java.lang.String`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`java.lang.Number`	the index of this item in the list.
`complexObjectIsFromSet`	`java.lang.Boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: io.cdktn.cdktn.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: java.lang.String

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: java.lang.Number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: java.lang.Boolean

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.
`resetGroupAttribute`	No description.
`resetSessionTimeout`	No description.
`resetUserAttribute`	No description.

`computeFqn`

public java.lang.String computeFqn()

`getAnyMapAttribute`

public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String property)

`property`^Required

Type: java.lang.String

`resolve`

public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

`_context`^Required

Type: io.cdktn.cdktn.IResolveContext

`toString`

public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetGroupAttribute`

public void resetGroupAttribute()

`resetSessionTimeout`

public void resetSessionTimeout()

`resetUserAttribute`

public void resetUserAttribute()

Properties

Name	Type	Description
`creationStack`	`java.util.List<java.lang.String>`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`java.lang.String`	No description.
`groupAttributeInput`	`java.lang.String`	No description.
`metadataInput`	`java.lang.String`	No description.
`sessionTimeoutInput`	`java.lang.Number`	No description.
`userAttributeInput`	`java.lang.String`	No description.
`groupAttribute`	`java.lang.String`	No description.
`metadata`	`java.lang.String`	No description.
`sessionTimeout`	`java.lang.Number`	No description.
`userAttribute`	`java.lang.String`	No description.
`internalValue`	`io.cdktn.cdktn.IResolvable\|OpensearchserverlessSecurityConfigSamlOptions`	No description.

`creationStack`^Required

public java.util.List<java.lang.String> getCreationStack();

Type: java.util.List<java.lang.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.

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`groupAttributeInput`^Optional

public java.lang.String getGroupAttributeInput();

Type: java.lang.String

`metadataInput`^Optional

public java.lang.String getMetadataInput();

Type: java.lang.String

`sessionTimeoutInput`^Optional

public java.lang.Number getSessionTimeoutInput();

Type: java.lang.Number

`userAttributeInput`^Optional

public java.lang.String getUserAttributeInput();

Type: java.lang.String

`groupAttribute`^Required

public java.lang.String getGroupAttribute();

Type: java.lang.String

`metadata`^Required

public java.lang.String getMetadata();

Type: java.lang.String

`sessionTimeout`^Required

public java.lang.Number getSessionTimeout();

Type: java.lang.Number

`userAttribute`^Required

public java.lang.String getUserAttribute();

Type: java.lang.String

`internalValue`^Optional

public IResolvable|OpensearchserverlessSecurityConfigSamlOptions getInternalValue();

Type: io.cdktn.cdktn.IResolvable|OpensearchserverlessSecurityConfigSamlOptions

FilesExpand file tree

opensearchserverlessSecurityConfig.java.md

Latest commit

History

opensearchserverlessSecurityConfig.java.md

File metadata and controls

opensearchserverlessSecurityConfig Submodule

Constructs