Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.AdvancedSecurityOptionsInputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.AdvancedSecurityOptionsInputProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.AdvancedSecurityOptionsInputProperty
extends software.amazon.jsii.JsiiSerializable

Specifies options for fine-grained access control.

If you specify advanced security options, you must also enable node-to-node encryption ( NodeToNodeEncryptionOptions ) and encryption at rest ( EncryptionAtRestOptions ). You must also enable EnforceHTTPS within DomainEndpointOptions , which requires HTTPS for all traffic to the domain.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchservice.*;
 AdvancedSecurityOptionsInputProperty advancedSecurityOptionsInputProperty = AdvancedSecurityOptionsInputProperty.builder()
         .anonymousAuthDisableDate("anonymousAuthDisableDate")
         .anonymousAuthEnabled(false)
         .enabled(false)
         .iamFederationOptions(Map.of(
                 "enabled", false,
                 "rolesKey", "rolesKey",
                 "subjectKey", "subjectKey"))
         .internalUserDatabaseEnabled(false)
         .jwtOptions(JWTOptionsProperty.builder()
                 .enabled(false)
                 .publicKey("publicKey")
                 .rolesKey("rolesKey")
                 .subjectKey("subjectKey")
                 .build())
         .masterUserOptions(MasterUserOptionsProperty.builder()
                 .masterUserArn("masterUserArn")
                 .masterUserName("masterUserName")
                 .masterUserPassword("masterUserPassword")
                 .build())
         .samlOptions(SAMLOptionsProperty.builder()
                 .enabled(false)
                 .idp(IdpProperty.builder()
                         .entityId("entityId")
                         .metadataContent("metadataContent")
                         .build())
                 .masterBackendRole("masterBackendRole")
                 .masterUserName("masterUserName")
                 .rolesKey("rolesKey")
                 .sessionTimeoutMinutes(123)
                 .subjectKey("subjectKey")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.AdvancedSecurityOptionsInputProperty.Builder	A builder for CfnDomain.AdvancedSecurityOptionsInputProperty
static final class	CfnDomain.AdvancedSecurityOptionsInputProperty.Jsii$Proxy	An implementation for CfnDomain.AdvancedSecurityOptionsInputProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.AdvancedSecurityOptionsInputProperty.Builder	builder()
default String	getAnonymousAuthDisableDate()	Date and time when the migration period will be disabled.
default Object	getAnonymousAuthEnabled()	True to enable a 30-day migration period during which administrators can create role mappings.
default Object	getEnabled()	True to enable fine-grained access control.
default Object	getIamFederationOptions()	Input configuration for IAM identity federation within advanced security options.
default Object	getInternalUserDatabaseEnabled()	True to enable the internal user database.
default Object	getJwtOptions()	Container for information about the JWT configuration of the Amazon OpenSearch Service.
default Object	getMasterUserOptions()	Specifies information about the master user.
default Object	getSamlOptions()	Container for information about the SAML configuration for OpenSearch Dashboards.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAnonymousAuthDisableDate

@Stability(Stable)
@Nullable
default String getAnonymousAuthDisableDate()

Date and time when the migration period will be disabled.

Only necessary when enabling fine-grained access control on an existing domain .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-anonymousauthdisabledate

getAnonymousAuthEnabled

@Stability(Stable)
@Nullable
default Object getAnonymousAuthEnabled()

True to enable a 30-day migration period during which administrators can create role mappings.

Only necessary when enabling fine-grained access control on an existing domain .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-anonymousauthenabled

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

True to enable fine-grained access control.

You must also enable encryption of data at rest and node-to-node encryption. See Fine-grained access control in Amazon OpenSearch Service .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-enabled

getIamFederationOptions

@Stability(Stable)
@Nullable
default Object getIamFederationOptions()

Input configuration for IAM identity federation within advanced security options.

Returns union: either IResolvable or CfnDomain.IAMFederationOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-iamfederationoptions

getInternalUserDatabaseEnabled

@Stability(Stable)
@Nullable
default Object getInternalUserDatabaseEnabled()

True to enable the internal user database.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-internaluserdatabaseenabled

getJwtOptions

@Stability(Stable)
@Nullable
default Object getJwtOptions()

Container for information about the JWT configuration of the Amazon OpenSearch Service.

Returns union: either IResolvable or CfnDomain.JWTOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-jwtoptions

getMasterUserOptions

@Stability(Stable)
@Nullable
default Object getMasterUserOptions()

Specifies information about the master user.

Returns union: either IResolvable or CfnDomain.MasterUserOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-masteruseroptions

getSamlOptions

@Stability(Stable)
@Nullable
default Object getSamlOptions()

Container for information about the SAML configuration for OpenSearch Dashboards.

Returns union: either IResolvable or CfnDomain.SAMLOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html#cfn-opensearchservice-domain-advancedsecurityoptionsinput-samloptions

builder

@Stability(Stable)
static CfnDomain.AdvancedSecurityOptionsInputProperty.Builder builder()

Returns:

a CfnDomain.AdvancedSecurityOptionsInputProperty.Builder of CfnDomain.AdvancedSecurityOptionsInputProperty