Package software.amazon.awscdk.services.opensearchservice

Class CfnDomainProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.opensearchservice.CfnDomainProps.Jsii$Proxy

All Implemented Interfaces:

CfnDomainProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDomainProps

@Stability(Stable)
@Internal
public static final class CfnDomainProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDomainProps

An implementation for CfnDomainProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.opensearchservice.CfnDomainProps

CfnDomainProps.Builder, CfnDomainProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDomainProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDomainProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAccessPolicies()	An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.
final Object	getAdvancedOptions()	Additional options to specify for the OpenSearch Service domain.
final Object	getAdvancedSecurityOptions()	Specifies options for fine-grained access control and SAML authentication.
final Object	getClusterConfig()	Container for the cluster configuration of a domain.
final Object	getCognitoOptions()	Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
final String	getDomainArn()
final Object	getDomainEndpointOptions()	Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.
final String	getDomainName()	A name for the OpenSearch Service domain.
final Object	getEbsOptions()	The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.
final Object	getEncryptionAtRestOptions()	Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.
final String	getEngineVersion()	The version of OpenSearch to use.
final Object	getIdentityCenterOptions()	Configuration options for controlling IAM Identity Center integration within a domain.
final String	getIpAddressType()	Choose either dual stack or IPv4 as your IP address type.
final Object	getLogPublishingOptions()	An object with one or more of the following keys: SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , AUDIT_LOGS , depending on the types of logs you want to publish.
final Object	getNodeToNodeEncryptionOptions()	Specifies whether node-to-node encryption is enabled.
final Object	getOffPeakWindowOptions()	Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
final Object	getSkipShardMigrationWait()	Returns union: either Boolean or IResolvable
final Object	getSnapshotOptions()	DEPRECATED .
final Object	getSoftwareUpdateOptions()	Service software update options for the domain.
final List<CfnTag>	getTags()	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
final Object	getVpcOptions()	The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDomainProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDomainProps.Builder.

Method Details

getAccessPolicies

public final Object getAccessPolicies()

Description copied from interface: CfnDomainProps

An AWS Identity and Access Management ( IAM ) policy document that specifies who can access the OpenSearch Service domain and their permissions.

For more information, see Configuring access policies in the Amazon OpenSearch Service Developer Guide .

Specified by:

getAccessPolicies in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-accesspolicies

getAdvancedOptions

public final Object getAdvancedOptions()

Description copied from interface: CfnDomainProps

Additional options to specify for the OpenSearch Service domain.

For more information, see AdvancedOptions in the OpenSearch Service API reference.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

Specified by:

getAdvancedOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedoptions

getAdvancedSecurityOptions

public final Object getAdvancedSecurityOptions()

Description copied from interface: CfnDomainProps

Specifies options for fine-grained access control and SAML authentication.

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.

Returns union: either IResolvable or CfnDomain.AdvancedSecurityOptionsInputProperty

Specified by:

getAdvancedSecurityOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-advancedsecurityoptions

getClusterConfig

public final Object getClusterConfig()

Description copied from interface: CfnDomainProps

Container for the cluster configuration of a domain.

Returns union: either IResolvable or CfnDomain.ClusterConfigProperty

Specified by:

getClusterConfig in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-clusterconfig

getCognitoOptions

public final Object getCognitoOptions()

Description copied from interface: CfnDomainProps

Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.

Returns union: either IResolvable or CfnDomain.CognitoOptionsProperty

Specified by:

getCognitoOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-cognitooptions

getDomainArn

public final String getDomainArn()

Specified by:

getDomainArn in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainarn

getDomainEndpointOptions

public final Object getDomainEndpointOptions()

Description copied from interface: CfnDomainProps

Specifies additional options for the domain endpoint, such as whether to require HTTPS for all traffic or whether to use a custom endpoint rather than the default endpoint.

Returns union: either IResolvable or CfnDomain.DomainEndpointOptionsProperty

Specified by:

getDomainEndpointOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainendpointoptions

getDomainName

public final String getDomainName()

Description copied from interface: CfnDomainProps

A name for the OpenSearch Service domain.

The name must have a minimum length of 3 and a maximum length of 28. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the domain name. For more information, see Name Type .

Required when creating a new domain.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Specified by:

getDomainName in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-domainname

getEbsOptions

public final Object getEbsOptions()

Description copied from interface: CfnDomainProps

The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the OpenSearch Service domain.

For more information, see EBS volume size limits in the Amazon OpenSearch Service Developer Guide .

Returns union: either IResolvable or CfnDomain.EBSOptionsProperty

Specified by:

getEbsOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-ebsoptions

getEncryptionAtRestOptions

public final Object getEncryptionAtRestOptions()

Description copied from interface: CfnDomainProps

Whether the domain should encrypt data at rest, and if so, the AWS KMS key to use.

See Encryption of data at rest for Amazon OpenSearch Service .

If no encryption at rest options were initially specified in the template, updating this property by adding it causes no interruption. However, if you change this property after it's already been set within a template, the domain is deleted and recreated in order to modify the property.

Returns union: either IResolvable or CfnDomain.EncryptionAtRestOptionsProperty

Specified by:

getEncryptionAtRestOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-encryptionatrestoptions

getEngineVersion

public final String getEngineVersion()

Description copied from interface: CfnDomainProps

The version of OpenSearch to use.

The value must be in the format OpenSearch_X.Y or Elasticsearch_X.Y . If not specified, the latest version of OpenSearch is used. For information about the versions that OpenSearch Service supports, see Supported versions of OpenSearch and Elasticsearch in the Amazon OpenSearch Service Developer Guide .

If you set the EnableVersionUpgrade update policy to true , you can update EngineVersion without interruption. When EnableVersionUpgrade is set to false , or is not specified, updating EngineVersion results in replacement .

Specified by:

getEngineVersion in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-engineversion

getIdentityCenterOptions

public final Object getIdentityCenterOptions()

Description copied from interface: CfnDomainProps

Configuration options for controlling IAM Identity Center integration within a domain.

Returns union: either IResolvable or CfnDomain.IdentityCenterOptionsProperty

Specified by:

getIdentityCenterOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-identitycenteroptions

getIpAddressType

public final String getIpAddressType()

Description copied from interface: CfnDomainProps

Choose either dual stack or IPv4 as your IP address type.

Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.

Specified by:

getIpAddressType in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-ipaddresstype

getLogPublishingOptions

public final Object getLogPublishingOptions()

Description copied from interface: CfnDomainProps

An object with one or more of the following keys: SEARCH_SLOW_LOGS , ES_APPLICATION_LOGS , INDEX_SLOW_LOGS , AUDIT_LOGS , depending on the types of logs you want to publish.

Each key needs a valid LogPublishingOption value. For the full syntax, see the examples .

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnDomain.LogPublishingOptionProperty>

Specified by:

getLogPublishingOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-logpublishingoptions

getNodeToNodeEncryptionOptions

public final Object getNodeToNodeEncryptionOptions()

Description copied from interface: CfnDomainProps

Specifies whether node-to-node encryption is enabled.

See Node-to-node encryption for Amazon OpenSearch Service .

Returns union: either IResolvable or CfnDomain.NodeToNodeEncryptionOptionsProperty

Specified by:

getNodeToNodeEncryptionOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-nodetonodeencryptionoptions

getOffPeakWindowOptions

public final Object getOffPeakWindowOptions()

Description copied from interface: CfnDomainProps

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

Returns union: either IResolvable or CfnDomain.OffPeakWindowOptionsProperty

Specified by:

getOffPeakWindowOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-offpeakwindowoptions

getSkipShardMigrationWait

public final Object getSkipShardMigrationWait()

Description copied from interface: CfnDomainProps

Returns union: either Boolean or IResolvable

Specified by:

getSkipShardMigrationWait in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-skipshardmigrationwait

getSnapshotOptions

public final Object getSnapshotOptions()

Description copied from interface: CfnDomainProps

DEPRECATED .

The automated snapshot configuration for the OpenSearch Service domain indexes.

Returns union: either IResolvable or CfnDomain.SnapshotOptionsProperty

Specified by:

getSnapshotOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-snapshotoptions

getSoftwareUpdateOptions

public final Object getSoftwareUpdateOptions()

Description copied from interface: CfnDomainProps

Service software update options for the domain.

Returns union: either IResolvable or CfnDomain.SoftwareUpdateOptionsProperty

Specified by:

getSoftwareUpdateOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-softwareupdateoptions

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnDomainProps

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.

Specified by:

getTags in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-tags

getVpcOptions

public final Object getVpcOptions()

Description copied from interface: CfnDomainProps

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

For more information, see Launching your Amazon OpenSearch Service domains within a VPC in the Amazon OpenSearch Service Developer Guide .

If you remove this entity altogether, along with its associated properties, it causes a replacement. You might encounter this scenario if you're updating your security configuration from a VPC to a public endpoint.

Returns union: either IResolvable or CfnDomain.VPCOptionsProperty

Specified by:

getVpcOptions in interface CfnDomainProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#cfn-opensearchservice-domain-vpcoptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object