@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-opensearchservice-domain.d.ts

@@ -0,0 +1,572 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type OpenSearchServiceDomain = ResourceDefinitionWithAttributes<"AWS::OpenSearchService::Domain", OpenSearchServiceDomainProps, OpenSearchServiceDomainAttribs>;
+/**
+ * The AWS::OpenSearchService::Domain resource creates an Amazon OpenSearch Service domain.
+ */
+export type OpenSearchServiceDomainProps = {
+    /**
+     * 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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ac.html#ac-creating) in the *Amazon OpenSearch Service Developer Guide* .
+     */
+    AccessPolicies?: Record<string, unknown> | undefined;
+    /**
+     * Additional options to specify for the OpenSearch Service domain. For more information, see [AdvancedOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateDomain.html#API_CreateDomain_RequestBody) in the OpenSearch Service API reference.
+     */
+    AdvancedOptions?: Record<string, string> | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html) ) and encryption at rest ( [EncryptionAtRestOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html) ). You must also enable `EnforceHTTPS` within [DomainEndpointOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html) , which requires HTTPS for all traffic to the domain.
+     */
+    AdvancedSecurityOptions?: AdvancedSecurityOptionsInput | undefined;
+    /**
+     * Container for the cluster configuration of a domain.
+     */
+    ClusterConfig?: ClusterConfig | undefined;
+    /**
+     * Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
+     */
+    CognitoOptions?: CognitoOptions | undefined;
+    /**
+     * 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.
+     */
+    DomainEndpointOptions?: DomainEndpointOptions | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
+     *
+     * 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.
+     */
+    DomainName?: string | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* .
+     */
+    EBSOptions?: EBSOptions | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/encryption-at-rest.html) .
+     *
+     * 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.
+     */
+    EncryptionAtRestOptions?: EncryptionAtRestOptions | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/what-is.html#choosing-version) in the *Amazon OpenSearch Service Developer Guide* .
+     *
+     * If you set the [EnableVersionUpgrade](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .
+     */
+    EngineVersion?: string | undefined;
+    /**
+     * 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.
+     */
+    IPAddressType?: string | undefined;
+    /**
+     * Configuration options for controlling IAM Identity Center integration within a domain.
+     */
+    IdentityCenterOptions?: IdentityCenterOptions | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--examples) .
+     */
+    LogPublishingOptions?: Record<string, LogPublishingOption> | undefined;
+    /**
+     * Specifies whether node-to-node encryption is enabled. See [Node-to-node encryption for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html) .
+     */
+    NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions | undefined;
+    /**
+     * Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
+     */
+    OffPeakWindowOptions?: OffPeakWindowOptions | undefined;
+    SkipShardMigrationWait?: boolean | undefined;
+    /**
+     * *DEPRECATED* . The automated snapshot configuration for the OpenSearch Service domain indexes.
+     */
+    SnapshotOptions?: SnapshotOptions | undefined;
+    /**
+     * Service software update options for the domain.
+     */
+    SoftwareUpdateOptions?: SoftwareUpdateOptions | undefined;
+    /**
+     * An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Service domain.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The virtual private cloud (VPC) configuration for the OpenSearch Service domain. For more information, see [Launching your Amazon OpenSearch Service domains within a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) 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.
+     */
+    VPCOptions?: VPCOptions | undefined;
+};
+export type OpenSearchServiceDomainAttribs = {
+    /**
+     * Date and time when the migration period will be disabled. Only necessary when [enabling fine-grained access control on an existing domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing) .
+     */
+    "AdvancedSecurityOptions.AnonymousAuthDisableDate": string;
+    /**
+     * The Amazon Resource Name (ARN) of the CloudFormation stack.
+     */
+    Arn: string;
+    DomainArn: string;
+    /**
+     * The domain-specific endpoint used for requests to the OpenSearch APIs, such as `search-mystack-1ab2cdefghij-ab1c2deckoyb3hofw7wpqa3cm.us-west-1.es.amazonaws.com` .
+     */
+    DomainEndpoint: string;
+    /**
+     * If `IPAddressType` to set to `dualstack` , a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.
+     */
+    DomainEndpointV2: string;
+    /**
+     * The resource ID. For example, `123456789012/my-domain` .
+     */
+    Id: string;
+    /**
+     * The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service.
+     */
+    "IdentityCenterOptions.IdentityCenterApplicationARN": string;
+    /**
+     * The identifier of the IAM Identity Store.
+     */
+    "IdentityCenterOptions.IdentityStoreId": string;
+};
+/**
+ * Specifies options for fine-grained access control.
+ *
+ * If you specify advanced security options, you must also enable node-to-node encryption ( [NodeToNodeEncryptionOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-nodetonodeencryptionoptions.html) ) and encryption at rest ( [EncryptionAtRestOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-encryptionatrestoptions.html) ). You must also enable `EnforceHTTPS` within [DomainEndpointOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-domainendpointoptions.html) , which requires HTTPS for all traffic to the domain.
+ */
+export type AdvancedSecurityOptionsInput = {
+    /**
+     * 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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing) .
+     */
+    AnonymousAuthEnabled?: boolean | undefined;
+    /**
+     * 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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html) .
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * True to enable the internal user database.
+     */
+    InternalUserDatabaseEnabled?: boolean | undefined;
+    /**
+     * Container for information about the JWT configuration of the Amazon OpenSearch Service.
+     */
+    JWTOptions?: JWTOptions | undefined;
+    /**
+     * Specifies information about the master user.
+     */
+    MasterUserOptions?: MasterUserOptions | undefined;
+    /**
+     * Container for information about the SAML configuration for OpenSearch Dashboards.
+     */
+    SAMLOptions?: SAMLOptions | undefined;
+};
+/**
+ * The cluster configuration for the OpenSearch Service domain. You can specify options such as the instance type and the number of instances. For more information, see [Creating and managing Amazon OpenSearch Service domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html) in the *Amazon OpenSearch Service Developer Guide* .
+ */
+export type ClusterConfig = {
+    /**
+     * Container for cold storage configuration options.
+     */
+    ColdStorageOptions?: ColdStorageOptions | undefined;
+    /**
+     * The number of instances to use for the master node. If you specify this property, you must specify `true` for the `DedicatedMasterEnabled` property.
+     */
+    DedicatedMasterCount?: number | undefined;
+    /**
+     * Indicates whether to use a dedicated master node for the OpenSearch Service domain. A dedicated master node is a cluster node that performs cluster management tasks, but doesn't hold data or respond to data upload requests. Dedicated master nodes offload cluster management tasks to increase the stability of your search clusters. See [Dedicated master nodes in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-dedicatedmasternodes.html) .
+     */
+    DedicatedMasterEnabled?: boolean | undefined;
+    /**
+     * The hardware configuration of the computer that hosts the dedicated master node, such as `m3.medium.search` . If you specify this property, you must specify `true` for the `DedicatedMasterEnabled` property. For valid values, see [Supported instance types in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) .
+     */
+    DedicatedMasterType?: string | undefined;
+    /**
+     * The number of data nodes (instances) to use in the OpenSearch Service domain.
+     */
+    InstanceCount?: number | undefined;
+    /**
+     * The instance type for your data nodes, such as `m3.medium.search` . For valid values, see [Supported instance types in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) .
+     */
+    InstanceType?: string | undefined;
+    /**
+     * Indicates whether Multi-AZ with Standby deployment option is enabled. For more information, see [Multi-AZ with Standby](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html#managedomains-za-standby) .
+     */
+    MultiAZWithStandbyEnabled?: boolean | undefined;
+    /**
+     * List of node options for the domain.
+     */
+    NodeOptions?: NodeOption[] | undefined;
+    /**
+     * The number of warm nodes in the cluster.
+     */
+    WarmCount?: number | undefined;
+    /**
+     * Whether to enable UltraWarm storage for the cluster. See [UltraWarm storage for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ultrawarm.html) .
+     */
+    WarmEnabled?: boolean | undefined;
+    /**
+     * The instance type for the cluster's warm nodes.
+     */
+    WarmType?: string | undefined;
+    /**
+     * Specifies zone awareness configuration options. Only use if `ZoneAwarenessEnabled` is `true` .
+     */
+    ZoneAwarenessConfig?: ZoneAwarenessConfig | undefined;
+    /**
+     * Indicates whether to enable zone awareness for the OpenSearch Service domain. When you enable zone awareness, OpenSearch Service allocates the nodes and replica index shards that belong to a cluster across two Availability Zones (AZs) in the same region to prevent data loss and minimize downtime in the event of node or data center failure. Don't enable zone awareness if your cluster has no replica index shards or is a single-node cluster. For more information, see [Configuring a multi-AZ domain in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html) .
+     */
+    ZoneAwarenessEnabled?: boolean | undefined;
+};
+/**
+ * Configures OpenSearch Service to use Amazon Cognito authentication for OpenSearch Dashboards.
+ */
+export type CognitoOptions = {
+    /**
+     * Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. See [Amazon Cognito authentication for OpenSearch Dashboards](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html) .
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
+     *
+     * Required if you enabled Cognito Authentication for OpenSearch Dashboards.
+     */
+    IdentityPoolId?: string | undefined;
+    /**
+     * The `AmazonOpenSearchServiceCognitoAccess` role that allows OpenSearch Service to configure your user pool and identity pool.
+     *
+     * Required if you enabled Cognito Authentication for OpenSearch Dashboards.
+     */
+    RoleArn?: string | undefined;
+    /**
+     * The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
+     *
+     * Required if you enabled Cognito Authentication for OpenSearch Dashboards.
+     */
+    UserPoolId?: string | undefined;
+};
+/**
+ * Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see [Cold storage for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html) .
+ */
+export type ColdStorageOptions = {
+    /**
+     * Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
+     */
+    Enabled?: boolean | undefined;
+};
+/**
+ * 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.
+ */
+export type DomainEndpointOptions = {
+    /**
+     * The fully qualified URL for your custom endpoint. Required if you enabled a custom endpoint for the domain.
+     */
+    CustomEndpoint?: string | undefined;
+    /**
+     * The AWS Certificate Manager ARN for your domain's SSL/TLS certificate. Required if you enabled a custom endpoint for the domain.
+     */
+    CustomEndpointCertificateArn?: string | undefined;
+    /**
+     * True to enable a custom endpoint for the domain. If enabled, you must also provide values for `CustomEndpoint` and `CustomEndpointCertificateArn` .
+     */
+    CustomEndpointEnabled?: boolean | undefined;
+    /**
+     * True to require that all traffic to the domain arrive over HTTPS. Required if you enable fine-grained access control in [AdvancedSecurityOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .
+     */
+    EnforceHTTPS?: boolean | undefined;
+    /**
+     * The minimum TLS version required for traffic to the domain. The policy can be one of the following values:
+     *
+     * - *Policy-Min-TLS-1-0-2019-07:* TLS security policy that supports TLS version 1.0 to TLS version 1.2
+     * - *Policy-Min-TLS-1-2-2019-07:* TLS security policy that supports only TLS version 1.2
+     * - *Policy-Min-TLS-1-2-PFS-2023-10:* TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
+     */
+    TLSSecurityPolicy?: string | undefined;
+};
+/**
+ * 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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* .
+ */
+export type EBSOptions = {
+    /**
+     * Specifies whether Amazon EBS volumes are attached to data nodes in the OpenSearch Service domain.
+     */
+    EBSEnabled?: boolean | undefined;
+    /**
+     * The number of I/O operations per second (IOPS) that the volume supports. This property applies only to the `gp3` and provisioned IOPS EBS volume types.
+     */
+    Iops?: number | undefined;
+    /**
+     * The throughput (in MiB/s) of the EBS volumes attached to data nodes. Applies only to the `gp3` volume type.
+     */
+    Throughput?: number | undefined;
+    /**
+     * The size (in GiB) of the EBS volume for each data node. The minimum and maximum size of an EBS volume depends on the EBS volume type and the instance type to which it is attached. For more information, see [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource) in the *Amazon OpenSearch Service Developer Guide* .
+     */
+    VolumeSize?: number | undefined;
+    /**
+     * The EBS volume type to use with the OpenSearch Service domain. If you choose `gp3` , you must also specify values for `Iops` and `Throughput` . For more information about each type, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon EC2 User Guide for Linux Instances* .
+     */
+    VolumeType?: string | undefined;
+};
+/**
+ * Whether the domain should encrypt data at rest, and if so, the AWS Key Management Service key to use.
+ */
+export type EncryptionAtRestOptions = {
+    /**
+     * Specify `true` to enable encryption at rest. Required if you enable fine-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .
+     *
+     * 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.
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * The KMS key ID. Takes the form `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a` . Required if you enable encryption at rest.
+     *
+     * You can also use `keyAlias` as a value.
+     *
+     * 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.
+     */
+    KmsKeyId?: string | undefined;
+};
+/**
+ * Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.
+ */
+export type IdentityCenterOptions = {
+    /**
+     * Indicates whether IAM Identity Center is enabled for the application.
+     */
+    EnabledAPIAccess?: boolean | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of the IAM Identity Center instance.
+     */
+    IdentityCenterInstanceARN?: string | undefined;
+    /**
+     * Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.
+     */
+    RolesKey?: RolesKeyIdcType | undefined;
+    /**
+     * Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.
+     */
+    SubjectKey?: SubjectKeyIdcType | undefined;
+};
+/**
+ * The SAML Identity Provider's information.
+ */
+export type Idp = {
+    /**
+     * The unique entity ID of the application in the SAML identity provider.
+     */
+    EntityId: string;
+    /**
+     * The metadata of the SAML application, in XML format.
+     * @minLength 1
+     * @maxLength 1048576
+     */
+    MetadataContent: string;
+};
+export type JWTOptions = {
+    Enabled?: boolean | undefined;
+    PublicKey?: string | undefined;
+    RolesKey?: string | undefined;
+    SubjectKey?: string | undefined;
+};
+/**
+ * Specifies whether the OpenSearch Service domain publishes application, search slow logs, or index slow logs to Amazon CloudWatch. Each option must be an object of name `SEARCH_SLOW_LOGS` , `ES_APPLICATION_LOGS` , `INDEX_SLOW_LOGS` , or `AUDIT_LOGS` depending on the type of logs you want to publish. For the full syntax, see the [examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html#aws-resource-opensearchservice-domain--examples) .
+ *
+ * Before you enable log publishing, you need to create a CloudWatch log group and provide OpenSearch Service the correct permissions to write to it. To learn more, see [Enabling log publishing ( AWS CloudFormation)](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html#createdomain-configure-slow-logs-cfn) .
+ */
+export type LogPublishingOption = {
+    /**
+     * Specifies the CloudWatch log group to publish to. Required if you enable log publishing.
+     */
+    CloudWatchLogsLogGroupArn?: string | undefined;
+    /**
+     * If `true` , enables the publishing of logs to CloudWatch.
+     *
+     * Default: `false` .
+     */
+    Enabled?: boolean | undefined;
+};
+/**
+ * Specifies information about the master user.
+ *
+ * Required if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .
+ */
+export type MasterUserOptions = {
+    /**
+     * Amazon Resource Name (ARN) for the master user. The ARN can point to an IAM user or role. This property is required for Amazon Cognito to work, and it must match the role configured for Cognito. Only specify if `InternalUserDatabaseEnabled` is false in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .
+     */
+    MasterUserARN?: string | undefined;
+    /**
+     * Username for the master user. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .
+     *
+     * If you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead.
+     */
+    MasterUserName?: string | undefined;
+    /**
+     * Password for the master user. Only specify if `InternalUserDatabaseEnabled` is true in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .
+     *
+     * If you don't want to specify this value directly within the template, you can use a [dynamic reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html) instead.
+     */
+    MasterUserPassword?: string | undefined;
+};
+/**
+ * Configuration options for defining the setup of any node type within the cluster.
+ */
+export type NodeConfig = {
+    /**
+     * The number of nodes of a specific type within the cluster.
+     */
+    Count?: number | undefined;
+    /**
+     * A boolean value indicating whether a specific node type is active or inactive.
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * The instance type of a particular node within the cluster.
+     */
+    Type?: string | undefined;
+};
+/**
+ * Configuration settings for defining the node type within a cluster.
+ */
+export type NodeOption = {
+    /**
+     * Configuration options for defining the setup of any node type.
+     */
+    NodeConfig?: NodeConfig | undefined;
+    /**
+     * Defines the type of node, such as coordinating nodes.
+     */
+    NodeType?: "coordinator" | undefined;
+};
+/**
+ * Specifies options for node-to-node encryption.
+ */
+export type NodeToNodeEncryptionOptions = {
+    /**
+     * Specifies to enable or disable node-to-node encryption on the domain. Required if you enable fine-grained access control in [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-advancedsecurityoptionsinput.html) .
+     */
+    Enabled?: boolean | undefined;
+};
+/**
+ * A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify. If you don't specify a window start time, it defaults to 10:00 P.M. local time.
+ */
+export type OffPeakWindow = {
+    /**
+     * The desired start time for an off-peak maintenance window.
+     */
+    WindowStartTime?: WindowStartTime | undefined;
+};
+/**
+ * Off-peak window settings for the domain.
+ */
+export type OffPeakWindowOptions = {
+    /**
+     * Specifies whether off-peak window settings are enabled for the domain.
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * Off-peak window settings for the domain.
+     */
+    OffPeakWindow?: OffPeakWindow | undefined;
+};
+/**
+ * Roles Key Idc type values.
+ */
+export type RolesKeyIdcType = "GroupName" | "GroupId";
+/**
+ * Container for information about the SAML configuration for OpenSearch Dashboards.
+ */
+export type SAMLOptions = {
+    /**
+     * True to enable SAML authentication for a domain.
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * The SAML Identity Provider's information.
+     */
+    Idp?: Idp | undefined;
+    /**
+     * The backend role that the SAML master user is mapped to.
+     */
+    MasterBackendRole?: string | undefined;
+    /**
+     * The SAML master user name, which is stored in the domain's internal user database.
+     */
+    MasterUserName?: string | undefined;
+    /**
+     * Element of the SAML assertion to use for backend roles. Default is `roles` .
+     */
+    RolesKey?: string | undefined;
+    /**
+     * The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
+     */
+    SessionTimeoutMinutes?: number | undefined;
+    /**
+     * Element of the SAML assertion to use for the user name. Default is `NameID` .
+     */
+    SubjectKey?: string | undefined;
+};
+/**
+ * *DEPRECATED* . This setting is only relevant to domains running legacy Elasticsearch OSS versions earlier than 5.3. It does not apply to OpenSearch domains.
+ *
+ * The automated snapshot configuration for the OpenSearch Service domain indexes.
+ */
+export type SnapshotOptions = {
+    /**
+     * The hour in UTC during which the service takes an automated daily snapshot of the indexes in the OpenSearch Service domain. For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am. You can specify a value between 0 and 23.
+     */
+    AutomatedSnapshotStartHour?: number | undefined;
+};
+/**
+ * Options for configuring service software updates for a domain.
+ */
+export type SoftwareUpdateOptions = {
+    /**
+     * Specifies whether automatic service software updates are enabled for the domain.
+     */
+    AutoSoftwareUpdateEnabled?: boolean | undefined;
+};
+/**
+ * Subject Key Idc type values.
+ */
+export type SubjectKeyIdcType = "UserName" | "UserId" | "Email";
+/**
+ * The virtual private cloud (VPC) configuration for the OpenSearch Service domain. For more information, see [Launching your Amazon OpenSearch Service domains using a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html) in the *Amazon OpenSearch Service Developer Guide* .
+ */
+export type VPCOptions = {
+    /**
+     * The list of security group IDs that are associated with the VPC endpoints for the domain. If you don't provide a security group ID, OpenSearch Service uses the default security group for the VPC. To learn more, see [Security groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html) in the *Amazon VPC User Guide* .
+     */
+    SecurityGroupIds?: string[] | undefined;
+    /**
+     * Provide one subnet ID for each Availability Zone that your domain uses. For example, you must specify three subnet IDs for a three-AZ domain. To learn more, see [VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) in the *Amazon VPC User Guide* .
+     *
+     * If you specify more than one subnet, you must also configure `ZoneAwarenessEnabled` and `ZoneAwarenessConfig` within [ClusterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-clusterconfig.html) , otherwise you'll see the error "You must specify exactly one subnet" during template creation.
+     */
+    SubnetIds?: string[] | undefined;
+};
+/**
+ * A custom 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.
+ */
+export type WindowStartTime = {
+    /**
+     * The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC. The minimum value is 0 and the maximum value is 23.
+     * @min 0
+     * @max 23
+     */
+    Hours: number;
+    /**
+     * The start minute of the window, in UTC. The minimum value is 0 and the maximum value is 59.
+     * @min 0
+     * @max 59
+     */
+    Minutes: number;
+};
+/**
+ * Specifies zone awareness configuration options. Only use if `ZoneAwarenessEnabled` is `true` .
+ */
+export type ZoneAwarenessConfig = {
+    /**
+     * If you enabled multiple Availability Zones (AZs), the number of AZs that you want the domain to use.
+     *
+     * Valid values are `2` and `3` . Default is 2.
+     */
+    AvailabilityZoneCount?: number | undefined;
+};
+//# sourceMappingURL=aws-opensearchservice-domain.d.ts.map