Domain

class aws_cdk.aws_opensearchservice.Domain(scope, id, *, version, access_policies=None, advanced_options=None, automated_snapshot_start_hour=None, capacity=None, cognito_dashboards_auth=None, cold_storage_enabled=None, custom_endpoint=None, domain_name=None, ebs=None, enable_auto_software_update=None, enable_version_upgrade=None, encryption_at_rest=None, enforce_https=None, fine_grained_access_control=None, ip_address_type=None, logging=None, node_to_node_encryption=None, off_peak_window_enabled=None, off_peak_window_start=None, removal_policy=None, security_groups=None, suppress_logs_resource_policy=None, tls_security_policy=None, use_unsigned_basic_auth=None, vpc=None, vpc_subnets=None, zone_awareness=None)

Bases: Resource

Provides an Amazon OpenSearch Service domain.

ExampleMetadata:: infused

Example:

domain = Domain(self, "Domain",
    version=EngineVersion.OPENSEARCH_1_0,
    ebs=EbsOptions(
        volume_size=100,
        volume_type=ec2.EbsDeviceVolumeType.GENERAL_PURPOSE_SSD
    ),
    node_to_node_encryption=True,
    encryption_at_rest=EncryptionAtRestOptions(
        enabled=True
    )
)

Parameters:

scope (Construct) –
id (str) –
version (EngineVersion) – The Elasticsearch/OpenSearch version that your domain will leverage.
access_policies (Optional[Sequence[PolicyStatement]]) – Domain access policies. Default: - No access policies.
advanced_options (Optional[Mapping[str, str]]) – Additional options to specify for the Amazon OpenSearch Service domain. Default: - no advanced options are specified
automated_snapshot_start_hour (Union[int, float, None]) – The hour in UTC during which the service takes an automated daily snapshot of the indices in the Amazon OpenSearch Service domain. Only applies for Elasticsearch versions below 5.3. Default: - Hourly automated snapshots not used
capacity (Union[CapacityConfig, Dict[str, Any], None]) – The cluster capacity configuration for the Amazon OpenSearch Service domain. Default: - 1 r5.large.search data node; no dedicated master nodes.
cognito_dashboards_auth (Union[CognitoOptions, Dict[str, Any], None]) – Configures Amazon OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards. Default: - Cognito not used for authentication to OpenSearch Dashboards.
cold_storage_enabled (Optional[bool]) – Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. Default: - undefined
custom_endpoint (Union[CustomEndpointOptions, Dict[str, Any], None]) – To configure a custom domain configure these options. If you specify a Route53 hosted zone it will create a CNAME record and use DNS validation for the certificate Default: - no custom domain endpoint will be configured
domain_name (Optional[str]) – Enforces a particular physical domain name. Default: - A name will be auto-generated.
ebs (Union[EbsOptions, Dict[str, Any], None]) – The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that are attached to data nodes in the Amazon OpenSearch Service domain. Default: - 10 GiB General Purpose (SSD) volumes per node.
enable_auto_software_update (Optional[bool]) – Specifies whether automatic service software updates are enabled for the domain. Default: - false
enable_version_upgrade (Optional[bool]) – To upgrade an Amazon OpenSearch Service domain to a new version, rather than replacing the entire domain resource, use the EnableVersionUpgrade update policy. Default: - false
encryption_at_rest (Union[EncryptionAtRestOptions, Dict[str, Any], None]) – Encryption at rest options for the cluster. Default: - No encryption at rest
enforce_https (Optional[bool]) – True to require that all traffic to the domain arrive over HTTPS. Default: - false
fine_grained_access_control (Union[AdvancedSecurityOptions, Dict[str, Any], None]) – Specifies options for fine-grained access control. Requires Elasticsearch version 6.7 or later or OpenSearch version 1.0 or later. Enabling fine-grained access control also requires encryption of data at rest and node-to-node encryption, along with enforced HTTPS. Default: - fine-grained access control is disabled
ip_address_type (Optional[IpAddressType]) – Specify 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. Default: - IpAddressType.IPV4
logging (Union[LoggingOptions, Dict[str, Any], None]) – Configuration log publishing configuration options. Default: - No logs are published
node_to_node_encryption (Optional[bool]) – Specify true to enable node to node encryption. Requires Elasticsearch version 6.0 or later or OpenSearch version 1.0 or later. Default: - Node to node encryption is not enabled.
off_peak_window_enabled (Optional[bool]) – Options for enabling a domain’s off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain. Off-peak windows were introduced on February 16, 2023. All domains created before this date have the off-peak window disabled by default. You must manually enable and configure the off-peak window for these domains. All domains created after this date will have the off-peak window enabled by default. You can’t disable the off-peak window for a domain after it’s enabled. Default: - Disabled for domains created before February 16, 2023. Enabled for domains created after. Enabled if offPeakWindowStart is set.
off_peak_window_start (Union[WindowStartTime, Dict[str, Any], None]) – Start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can’t specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. Default: - 10:00 P.M. local time
removal_policy (Optional[RemovalPolicy]) – Policy to apply when the domain is removed from the stack. Default: RemovalPolicy.RETAIN
security_groups (Optional[Sequence[ISecurityGroup]]) – The list of security groups that are associated with the VPC endpoints for the domain. Only used if vpc is specified. Default: - One new security group is created.
suppress_logs_resource_policy (Optional[bool]) – Specify whether to create a CloudWatch Logs resource policy or not. When logging is enabled for the domain, a CloudWatch Logs resource policy is created by default. However, CloudWatch Logs supports only 10 resource policies per region. If you enable logging for several domains, it may hit the quota and cause an error. By setting this property to true, creating a resource policy is suppressed, allowing you to avoid this problem. If you set this option to true, you must create a resource policy before deployment. Default: - false
tls_security_policy (Optional[TLSSecurityPolicy]) – The minimum TLS version required for traffic to the domain. Default: - TLSSecurityPolicy.TLS_1_0
use_unsigned_basic_auth (Optional[bool]) – Configures the domain so that unsigned basic auth is enabled. If no master user is provided a default master user with username admin and a dynamically generated password stored in KMS is created. The password can be retrieved by getting masterUserPassword from the domain instance. Setting this to true will also add an access policy that allows unsigned access, enable node to node encryption, encryption at rest. If conflicting settings are encountered (like disabling encryption at rest) enabling this setting will cause a failure. Default: - false
vpc (Optional[IVpc]) – Place the domain inside this VPC. Default: - Domain is not placed in a VPC.
vpc_subnets (Optional[Sequence[Union[SubnetSelection, Dict[str, Any]]]]) – The specific vpc subnets the domain will be placed in. You must provide one subnet for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three Availability Zone domain. Only used if vpc is specified. Default: - All private subnets.
zone_awareness (Union[ZoneAwarenessConfig, Dict[str, Any], None]) – The cluster zone awareness configuration for the Amazon OpenSearch Service domain. Default: - no zone awareness (1 AZ)

Methods

add_access_policies(*access_policy_statements)

Add policy statements to the domain access policy.

Parameters:

access_policy_statements (PolicyStatement) –

Return type:

None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

grant_index_read(index, identity)

Grant read permissions for an index in this domain to an IAM principal (Role/Group/User).

Parameters:

index (str) – The index to grant permissions for.
identity (IGrantable) – The principal.

Return type:

Grant

grant_index_read_write(index, identity)

Grant read/write permissions for an index in this domain to an IAM principal (Role/Group/User).

Parameters:

index (str) – The index to grant permissions for.
identity (IGrantable) – The principal.

Return type:

Grant

grant_index_write(index, identity)

Grant write permissions for an index in this domain to an IAM principal (Role/Group/User).

Parameters:

index (str) – The index to grant permissions for.
identity (IGrantable) – The principal.

Return type:

Grant

grant_path_read(path, identity)

Grant read permissions for a specific path in this domain to an IAM principal (Role/Group/User).

Parameters:

path (str) – The path to grant permissions for.
identity (IGrantable) – The principal.

Return type:

Grant

grant_path_read_write(path, identity)

Grant read/write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

Parameters:

path (str) – The path to grant permissions for.
identity (IGrantable) – The principal.

Return type:

Grant

grant_path_write(path, identity)

Grant write permissions for a specific path in this domain to an IAM principal (Role/Group/User).

Parameters:

path (str) – The path to grant permissions for.
identity (IGrantable) – The principal.

Return type:

Grant

grant_read(identity)

Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).

Parameters:: identity (IGrantable) – The principal.
Return type:: Grant

grant_read_write(identity)

Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).

Parameters:: identity (IGrantable) – The principal.
Return type:: Grant

grant_write(identity)

Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).

Parameters:: identity (IGrantable) – The principal.
Return type:: Grant

metric(metric_name, *, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, stack_account=None, stack_region=None, statistic=None, unit=None)

Return the given named metric for this domain.

Parameters:

metric_name (str) –
account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions_map (Optional[Mapping[str, str]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph’s legend. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
stack_account (Optional[str]) – Account of the stack this metric is attached to. Default: - Deployment account.
stack_region (Optional[str]) – Region of the stack this metric is attached to. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Use the aws_cloudwatch.Stats helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Return type: