opensearch

opensearch can be used to define an AWS OpenSearch Service.

Attributes

Schema OpenSearch

Name and Description	Type	Default Value	Required
clusterConfig The configurations for the cluster of the domain.	ClusterConfig	Undefined	False
ebsOptions The options for EBS volumes attached to data nodes in the domain.	EbsOptions	Undefined	False
region The AWS region.	str	Undefined	True
statement The statement of the OpenSearch Service.	Statement[]		True

Schema ClusterConfig

Name and Description	Type	Default Value	Required
instanceType The instance type of data nodes in the cluster.	str	Undefined	False

Schema EbsOptions

Name and Description	Type	Default Value	Required
ebsEnabled Whether EBS volumes are attached to data nodes in the domain.	bool	False	False
volumeSize The size of EBS volumes attached to data nodes (in GiB).	int	Undefined	Required if ebsEnabled is set to True

Schema Statement

Name and Description	Type	Default Value	Required
effect Whether this statement allows or denies the given actions. Valid values are Allow and Deny.	"Allow" or "Deny"	"Allow"	True
principles The configuration block for principals.	Principal	Undefined	False
action The list of actions that this statement either allows or denies.	[]str	Undefined	False

Schema Principal

Name and Description	Type	Default Value	Required
type The type of principal. Valid values include AWS, Service, Federated, CanonicalUser and *.	str	Undefined	False
identifiers The list of identifiers for principals.	[]str	Undefined	False

Examples

modules: 
    opensearch:
        path: oci://ghcr.io/kusionstack/opensearch
        version: 0.1.0
        configs:
            default:
                region: us-east-1
                clusterConfig:
                    instanceType: r6g.large.search
                ebsEnabled: true
                volumeSize: 10
                statement:
                - effect: Allow
                principals:
                - type: AWS
                    identifiers:
                    - "*"
                action:
                - es:*