Class: AWSCDK::OpenSearchService::CfnDomainProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
open_search_service/cfn_domain_props.rb

Overview

Properties for defining a CfnDomain.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_policies: nil, advanced_options: nil, advanced_security_options: nil, aiml_options: nil, automated_snapshot_pause_options: nil, cluster_config: nil, cognito_options: nil, deployment_strategy_options: nil, domain_arn: nil, domain_endpoint_options: nil, domain_name: nil, ebs_options: nil, encryption_at_rest_options: nil, engine_version: nil, identity_center_options: nil, ip_address_type: nil, log_publishing_options: nil, node_to_node_encryption_options: nil, off_peak_window_options: nil, skip_shard_migration_wait: nil, snapshot_options: nil, software_update_options: nil, tags: nil, vpc_options: nil) ⇒ CfnDomainProps

Returns a new instance of CfnDomainProps.

Parameters:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'open_search_service/cfn_domain_props.rb', line 33

def initialize(access_policies: nil, advanced_options: nil, advanced_security_options: nil, aiml_options: nil, automated_snapshot_pause_options: nil, cluster_config: nil, cognito_options: nil, deployment_strategy_options: nil, domain_arn: nil, domain_endpoint_options: nil, domain_name: nil, ebs_options: nil, encryption_at_rest_options: nil, engine_version: nil, identity_center_options: nil, ip_address_type: nil, log_publishing_options: nil, node_to_node_encryption_options: nil, off_peak_window_options: nil, skip_shard_migration_wait: nil, snapshot_options: nil, software_update_options: nil, tags: nil, vpc_options: nil)
  @access_policies = access_policies
  Jsii::Type.check_type(@access_policies, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "accessPolicies") unless @access_policies.nil?
  @advanced_options = advanced_options
  Jsii::Type.check_type(@advanced_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "advancedOptions") unless @advanced_options.nil?
  @advanced_security_options = advanced_security_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::AdvancedSecurityOptionsInputProperty.new(**advanced_security_options.transform_keys(&:to_sym)) : advanced_security_options
  Jsii::Type.check_type(@advanced_security_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQWR2YW5jZWRTZWN1cml0eU9wdGlvbnNJbnB1dFByb3BlcnR5In1dfX0=")), "advancedSecurityOptions") unless @advanced_security_options.nil?
  @aiml_options = aiml_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::AIMLOptionsProperty.new(**aiml_options.transform_keys(&:to_sym)) : aiml_options
  Jsii::Type.check_type(@aiml_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQUlNTE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "aimlOptions") unless @aiml_options.nil?
  @automated_snapshot_pause_options = automated_snapshot_pause_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::AutomatedSnapshotPauseOptionsProperty.new(**automated_snapshot_pause_options.transform_keys(&:to_sym)) : automated_snapshot_pause_options
  Jsii::Type.check_type(@automated_snapshot_pause_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQXV0b21hdGVkU25hcHNob3RQYXVzZU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "automatedSnapshotPauseOptions") unless @automated_snapshot_pause_options.nil?
  @cluster_config = cluster_config.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::ClusterConfigProperty.new(**cluster_config.transform_keys(&:to_sym)) : cluster_config
  Jsii::Type.check_type(@cluster_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQ2x1c3RlckNvbmZpZ1Byb3BlcnR5In1dfX0=")), "clusterConfig") unless @cluster_config.nil?
  @cognito_options = cognito_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::CognitoOptionsProperty.new(**cognito_options.transform_keys(&:to_sym)) : cognito_options
  Jsii::Type.check_type(@cognito_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uQ29nbml0b09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "cognitoOptions") unless @cognito_options.nil?
  @deployment_strategy_options = deployment_strategy_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::DeploymentStrategyOptionsProperty.new(**deployment_strategy_options.transform_keys(&:to_sym)) : deployment_strategy_options
  Jsii::Type.check_type(@deployment_strategy_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uRGVwbG95bWVudFN0cmF0ZWd5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "deploymentStrategyOptions") unless @deployment_strategy_options.nil?
  @domain_arn = domain_arn
  Jsii::Type.check_type(@domain_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainArn") unless @domain_arn.nil?
  @domain_endpoint_options = domain_endpoint_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::DomainEndpointOptionsProperty.new(**domain_endpoint_options.transform_keys(&:to_sym)) : domain_endpoint_options
  Jsii::Type.check_type(@domain_endpoint_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uRG9tYWluRW5kcG9pbnRPcHRpb25zUHJvcGVydHkifV19fQ==")), "domainEndpointOptions") unless @domain_endpoint_options.nil?
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName") unless @domain_name.nil?
  @ebs_options = ebs_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::EBSOptionsProperty.new(**ebs_options.transform_keys(&:to_sym)) : ebs_options
  Jsii::Type.check_type(@ebs_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uRUJTT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "ebsOptions") unless @ebs_options.nil?
  @encryption_at_rest_options = encryption_at_rest_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::EncryptionAtRestOptionsProperty.new(**encryption_at_rest_options.transform_keys(&:to_sym)) : encryption_at_rest_options
  Jsii::Type.check_type(@encryption_at_rest_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uRW5jcnlwdGlvbkF0UmVzdE9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "encryptionAtRestOptions") unless @encryption_at_rest_options.nil?
  @engine_version = engine_version
  Jsii::Type.check_type(@engine_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless @engine_version.nil?
  @identity_center_options = identity_center_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::IdentityCenterOptionsProperty.new(**identity_center_options.transform_keys(&:to_sym)) : identity_center_options
  Jsii::Type.check_type(@identity_center_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uSWRlbnRpdHlDZW50ZXJPcHRpb25zUHJvcGVydHkifV19fQ==")), "identityCenterOptions") unless @identity_center_options.nil?
  @ip_address_type = ip_address_type
  Jsii::Type.check_type(@ip_address_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipAddressType") unless @ip_address_type.nil?
  @log_publishing_options = log_publishing_options
  Jsii::Type.check_type(@log_publishing_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3BlbnNlYXJjaHNlcnZpY2UuQ2ZuRG9tYWluLkxvZ1B1Ymxpc2hpbmdPcHRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "logPublishingOptions") unless @log_publishing_options.nil?
  @node_to_node_encryption_options = node_to_node_encryption_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::NodeToNodeEncryptionOptionsProperty.new(**node_to_node_encryption_options.transform_keys(&:to_sym)) : node_to_node_encryption_options
  Jsii::Type.check_type(@node_to_node_encryption_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uTm9kZVRvTm9kZUVuY3J5cHRpb25PcHRpb25zUHJvcGVydHkifV19fQ==")), "nodeToNodeEncryptionOptions") unless @node_to_node_encryption_options.nil?
  @off_peak_window_options = off_peak_window_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::OffPeakWindowOptionsProperty.new(**off_peak_window_options.transform_keys(&:to_sym)) : off_peak_window_options
  Jsii::Type.check_type(@off_peak_window_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uT2ZmUGVha1dpbmRvd09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "offPeakWindowOptions") unless @off_peak_window_options.nil?
  @skip_shard_migration_wait = skip_shard_migration_wait
  Jsii::Type.check_type(@skip_shard_migration_wait, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "skipShardMigrationWait") unless @skip_shard_migration_wait.nil?
  @snapshot_options = snapshot_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::SnapshotOptionsProperty.new(**snapshot_options.transform_keys(&:to_sym)) : snapshot_options
  Jsii::Type.check_type(@snapshot_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uU25hcHNob3RPcHRpb25zUHJvcGVydHkifV19fQ==")), "snapshotOptions") unless @snapshot_options.nil?
  @software_update_options = software_update_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::SoftwareUpdateOptionsProperty.new(**software_update_options.transform_keys(&:to_sym)) : software_update_options
  Jsii::Type.check_type(@software_update_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uU29mdHdhcmVVcGRhdGVPcHRpb25zUHJvcGVydHkifV19fQ==")), "softwareUpdateOptions") unless @software_update_options.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @vpc_options = vpc_options.is_a?(Hash) ? ::AWSCDK::OpenSearchService::CfnDomain::VPCOptionsProperty.new(**vpc_options.transform_keys(&:to_sym)) : vpc_options
  Jsii::Type.check_type(@vpc_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcGVuc2VhcmNoc2VydmljZS5DZm5Eb21haW4uVlBDT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "vpcOptions") unless @vpc_options.nil?
end

Instance Attribute Details

#access_policies ⇒ Object? (readonly)

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 .

Returns:

  • (Object, nil)

See Also:



90
91
92
 
# File 'open_search_service/cfn_domain_props.rb', line 90

def access_policies
  @access_policies
end

#advanced_options ⇒ AWSCDK::IResolvable, ... (readonly)

Additional options to specify for the OpenSearch Service domain.

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

Returns:

See Also:



97
98
99
 
# File 'open_search_service/cfn_domain_props.rb', line 97

def advanced_options
  @advanced_options
end

#advanced_security_options ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



104
105
106
 
# File 'open_search_service/cfn_domain_props.rb', line 104

def advanced_security_options
  @advanced_security_options
end

#aiml_options ⇒ AWSCDK::IResolvable, ... (readonly)

Container for parameters required to enable all machine learning features.

Returns:

See Also:



109
110
111
 
# File 'open_search_service/cfn_domain_props.rb', line 109

def aiml_options
  @aiml_options
end

#automated_snapshot_pause_options ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



112
113
114
 
# File 'open_search_service/cfn_domain_props.rb', line 112

def automated_snapshot_pause_options
  @automated_snapshot_pause_options
end

#cluster_config ⇒ AWSCDK::IResolvable, ... (readonly)

Container for the cluster configuration of a domain.

Returns:

See Also:



117
118
119
 
# File 'open_search_service/cfn_domain_props.rb', line 117

def cluster_config
  @cluster_config
end

#cognito_options ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



122
123
124
 
# File 'open_search_service/cfn_domain_props.rb', line 122

def cognito_options
  @cognito_options
end

#deployment_strategy_options ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



125
126
127
 
# File 'open_search_service/cfn_domain_props.rb', line 125

def deployment_strategy_options
  @deployment_strategy_options
end

#domain_arn ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



128
129
130
 
# File 'open_search_service/cfn_domain_props.rb', line 128

def domain_arn
  @domain_arn
end

#domain_endpoint_options ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



133
134
135
 
# File 'open_search_service/cfn_domain_props.rb', line 133

def domain_endpoint_options
  @domain_endpoint_options
end

#domain_name ⇒ String? (readonly)

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, 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.

Returns:

  • (String, nil)

See Also:



144
145
146
 
# File 'open_search_service/cfn_domain_props.rb', line 144

def domain_name
  @domain_name
end

#ebs_options ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



151
152
153
 
# File 'open_search_service/cfn_domain_props.rb', line 151

def ebs_options
  @ebs_options
end

#encryption_at_rest_options ⇒ AWSCDK::IResolvable, ... (readonly)

Whether the domain should encrypt data at rest, and if so, the AWS 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:

See Also:



160
161
162
 
# File 'open_search_service/cfn_domain_props.rb', line 160

def encryption_at_rest_options
  @encryption_at_rest_options
end

#engine_version ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



169
170
171
 
# File 'open_search_service/cfn_domain_props.rb', line 169

def engine_version
  @engine_version
end

#identity_center_options ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



174
175
176
 
# File 'open_search_service/cfn_domain_props.rb', line 174

def identity_center_options
  @identity_center_options
end

#ip_address_type ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



181
182
183
 
# File 'open_search_service/cfn_domain_props.rb', line 181

def ip_address_type
  @ip_address_type
end

#log_publishing_options ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



188
189
190
 
# File 'open_search_service/cfn_domain_props.rb', line 188

def log_publishing_options
  @log_publishing_options
end

#node_to_node_encryption_options ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies whether node-to-node encryption is enabled.

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

Returns:

See Also:



195
196
197
 
# File 'open_search_service/cfn_domain_props.rb', line 195

def node_to_node_encryption_options
  @node_to_node_encryption_options
end

#off_peak_window_options ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



200
201
202
 
# File 'open_search_service/cfn_domain_props.rb', line 200

def off_peak_window_options
  @off_peak_window_options
end

#skip_shard_migration_wait ⇒ Boolean, ... (readonly)

Returns:

See Also:



203
204
205
 
# File 'open_search_service/cfn_domain_props.rb', line 203

def skip_shard_migration_wait
  @skip_shard_migration_wait
end

#snapshot_options ⇒ AWSCDK::IResolvable, ... (readonly)

DEPRECATED .

The automated snapshot configuration for the OpenSearch Service domain indexes.

Returns:

See Also:



210
211
212
 
# File 'open_search_service/cfn_domain_props.rb', line 210

def snapshot_options
  @snapshot_options
end

#software_update_options ⇒ AWSCDK::IResolvable, ... (readonly)

Service software update options for the domain.

Returns:

See Also:



215
216
217
 
# File 'open_search_service/cfn_domain_props.rb', line 215

def software_update_options
  @software_update_options
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

Returns:

See Also:



220
221
222
 
# File 'open_search_service/cfn_domain_props.rb', line 220

def tags
  @tags
end

#vpc_options ⇒ AWSCDK::IResolvable, ... (readonly)

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:

See Also:



229
230
231
 
# File 'open_search_service/cfn_domain_props.rb', line 229

def vpc_options
  @vpc_options
end

Class Method Details

.jsii_properties ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'open_search_service/cfn_domain_props.rb', line 231

def self.jsii_properties
  {
    :access_policies => "accessPolicies",
    :advanced_options => "advancedOptions",
    :advanced_security_options => "advancedSecurityOptions",
    :aiml_options => "aimlOptions",
    :automated_snapshot_pause_options => "automatedSnapshotPauseOptions",
    :cluster_config => "clusterConfig",
    :cognito_options => "cognitoOptions",
    :deployment_strategy_options => "deploymentStrategyOptions",
    :domain_arn => "domainArn",
    :domain_endpoint_options => "domainEndpointOptions",
    :domain_name => "domainName",
    :ebs_options => "ebsOptions",
    :encryption_at_rest_options => "encryptionAtRestOptions",
    :engine_version => "engineVersion",
    :identity_center_options => "identityCenterOptions",
    :ip_address_type => "ipAddressType",
    :log_publishing_options => "logPublishingOptions",
    :node_to_node_encryption_options => "nodeToNodeEncryptionOptions",
    :off_peak_window_options => "offPeakWindowOptions",
    :skip_shard_migration_wait => "skipShardMigrationWait",
    :snapshot_options => "snapshotOptions",
    :software_update_options => "softwareUpdateOptions",
    :tags => "tags",
    :vpc_options => "vpcOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'open_search_service/cfn_domain_props.rb', line 260

def to_jsii
  result = {}
  result.merge!({
    "accessPolicies" => @access_policies,
    "advancedOptions" => @advanced_options,
    "advancedSecurityOptions" => @advanced_security_options,
    "aimlOptions" => @aiml_options,
    "automatedSnapshotPauseOptions" => @automated_snapshot_pause_options,
    "clusterConfig" => @cluster_config,
    "cognitoOptions" => @cognito_options,
    "deploymentStrategyOptions" => @deployment_strategy_options,
    "domainArn" => @domain_arn,
    "domainEndpointOptions" => @domain_endpoint_options,
    "domainName" => @domain_name,
    "ebsOptions" => @ebs_options,
    "encryptionAtRestOptions" => @encryption_at_rest_options,
    "engineVersion" => @engine_version,
    "identityCenterOptions" => @identity_center_options,
    "ipAddressType" => @ip_address_type,
    "logPublishingOptions" => @log_publishing_options,
    "nodeToNodeEncryptionOptions" => @node_to_node_encryption_options,
    "offPeakWindowOptions" => @off_peak_window_options,
    "skipShardMigrationWait" => @skip_shard_migration_wait,
    "snapshotOptions" => @snapshot_options,
    "softwareUpdateOptions" => @software_update_options,
    "tags" => @tags,
    "vpcOptions" => @vpc_options,
  })
  result.compact
end