Interface AdvancedSecurityOptions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AdvancedSecurityOptions.Builder,AdvancedSecurityOptions>, SdkBuilder<AdvancedSecurityOptions.Builder,AdvancedSecurityOptions>, SdkPojo

Enclosing class:

AdvancedSecurityOptions

@Mutable
@NotThreadSafe
public static interface AdvancedSecurityOptions.Builder
extends SdkPojo, CopyableBuilder<AdvancedSecurityOptions.Builder,AdvancedSecurityOptions>

Method Summary

Modifier and Type	Method	Description
AdvancedSecurityOptions.Builder	anonymousAuthDisableDate(Instant anonymousAuthDisableDate)	Date and time when the migration period will be disabled.
AdvancedSecurityOptions.Builder	anonymousAuthEnabled(Boolean anonymousAuthEnabled)	True if a 30-day migration period is enabled, during which administrators can create role mappings.
AdvancedSecurityOptions.Builder	enabled(Boolean enabled)	True if fine-grained access control is enabled.
default AdvancedSecurityOptions.Builder	iamFederationOptions(Consumer<IAMFederationOptionsOutput.Builder> iamFederationOptions)	Container for information about the IAM federation configuration for an OpenSearch UI application.
AdvancedSecurityOptions.Builder	iamFederationOptions(IAMFederationOptionsOutput iamFederationOptions)	Container for information about the IAM federation configuration for an OpenSearch UI application.
AdvancedSecurityOptions.Builder	internalUserDatabaseEnabled(Boolean internalUserDatabaseEnabled)	True if the internal user database is enabled.
default AdvancedSecurityOptions.Builder	jwtOptions(Consumer<JWTOptionsOutput.Builder> jwtOptions)	Container for information about the JWT configuration of the Amazon OpenSearch Service.
AdvancedSecurityOptions.Builder	jwtOptions(JWTOptionsOutput jwtOptions)	Container for information about the JWT configuration of the Amazon OpenSearch Service.
default AdvancedSecurityOptions.Builder	samlOptions(Consumer<SAMLOptionsOutput.Builder> samlOptions)	Container for information about the SAML configuration for OpenSearch Dashboards.
AdvancedSecurityOptions.Builder	samlOptions(SAMLOptionsOutput samlOptions)	Container for information about the SAML configuration for OpenSearch Dashboards.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

enabled

AdvancedSecurityOptions.Builder enabled(Boolean enabled)

True if fine-grained access control is enabled.

Parameters:

enabled - True if fine-grained access control is enabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

internalUserDatabaseEnabled

AdvancedSecurityOptions.Builder internalUserDatabaseEnabled(Boolean internalUserDatabaseEnabled)

True if the internal user database is enabled.

Parameters:

internalUserDatabaseEnabled - True if the internal user database is enabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

samlOptions

AdvancedSecurityOptions.Builder samlOptions(SAMLOptionsOutput samlOptions)

Container for information about the SAML configuration for OpenSearch Dashboards.

Parameters:

samlOptions - Container for information about the SAML configuration for OpenSearch Dashboards.

Returns:

Returns a reference to this object so that method calls can be chained together.

samlOptions

default AdvancedSecurityOptions.Builder samlOptions(Consumer<SAMLOptionsOutput.Builder> samlOptions)

Container for information about the SAML configuration for OpenSearch Dashboards.

This is a convenience method that creates an instance of the SAMLOptionsOutput.Builder avoiding the need to create one manually via SAMLOptionsOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to samlOptions(SAMLOptionsOutput).

Parameters:

samlOptions - a consumer that will call methods on SAMLOptionsOutput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• samlOptions(SAMLOptionsOutput)

jwtOptions

AdvancedSecurityOptions.Builder jwtOptions(JWTOptionsOutput jwtOptions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

jwtOptions

default AdvancedSecurityOptions.Builder jwtOptions(Consumer<JWTOptionsOutput.Builder> jwtOptions)

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

This is a convenience method that creates an instance of the JWTOptionsOutput.Builder avoiding the need to create one manually via JWTOptionsOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jwtOptions(JWTOptionsOutput).

Parameters:

jwtOptions - a consumer that will call methods on JWTOptionsOutput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• jwtOptions(JWTOptionsOutput)

iamFederationOptions

AdvancedSecurityOptions.Builder iamFederationOptions(IAMFederationOptionsOutput iamFederationOptions)

Container for information about the IAM federation configuration for an OpenSearch UI application.

Parameters:

iamFederationOptions - Container for information about the IAM federation configuration for an OpenSearch UI application.

Returns:

Returns a reference to this object so that method calls can be chained together.

iamFederationOptions

default AdvancedSecurityOptions.Builder iamFederationOptions(Consumer<IAMFederationOptionsOutput.Builder> iamFederationOptions)

Container for information about the IAM federation configuration for an OpenSearch UI application.

This is a convenience method that creates an instance of the IAMFederationOptionsOutput.Builder avoiding the need to create one manually via IAMFederationOptionsOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to iamFederationOptions(IAMFederationOptionsOutput).

Parameters:

iamFederationOptions - a consumer that will call methods on IAMFederationOptionsOutput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• iamFederationOptions(IAMFederationOptionsOutput)

anonymousAuthDisableDate

AdvancedSecurityOptions.Builder anonymousAuthDisableDate(Instant anonymousAuthDisableDate)

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

Parameters:

anonymousAuthDisableDate - Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

anonymousAuthEnabled

AdvancedSecurityOptions.Builder anonymousAuthEnabled(Boolean anonymousAuthEnabled)

True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

Parameters:

anonymousAuthEnabled - True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

Returns:

Returns a reference to this object so that method calls can be chained together.