Domain is the Schema for the Domains API.
Type
CRD
Group
opensearch.aws.upbound.io
Version
v1beta1
apiVersion: opensearch.aws.upbound.io/v1beta1
kind: Domain
DomainSpec defines the desired state of Domain
No description provided.
Configuration block for fine-grained access control. Detailed below.
Configuration block for the main user. Detailed below.
Configuration block for the Auto-Tune options of the domain. Detailed below.
Configuration block for the cluster of the domain. Detailed below.
Configuration block containing cold storage configuration. Detailed below.
Configuration block containing zone awareness settings. Detailed below.
Configuration block for authenticating dashboard with Cognito. Detailed below.
Configuration block for domain endpoint HTTP(S) related options. Detailed below.
Configuration block for EBS related options, may be required based on chosen instance size. Detailed below.
Configuration block for publishing slow and application logs to CloudWatch Logs. This block can be declared multiple times, for each log_type, within the same resource. Detailed below.
Reference to a Group in cloudwatchlogs to populate cloudwatchLogGroupArn.
Policies for referencing.
Selector for a Group in cloudwatchlogs to populate cloudwatchLogGroupArn.
Policies for selection.
Configuration block for node-to-node encryption options. Detailed below.
Configuration to add Off Peak update options. (documentation). Detailed below.
No description provided.
Configuration block for snapshot related options. Detailed below. DEPRECATED. For domains running OpenSearch 5.3 and later, Amazon OpenSearch takes hourly automated snapshots, making this setting irrelevant. For domains running earlier versions, OpenSearch takes daily automated snapshots.
Software update options for the domain. Detailed below.
Configuration block for VPC related options. Adding or removing this configuration forces a new resource (documentation). Detailed below.
List of VPC Security Group IDs to be applied to the OpenSearch domain endpoints. If omitted, the default Security Group for the VPC will be used.
List of VPC Subnet IDs for the OpenSearch domain endpoints to be created in.
THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.
Configuration block for fine-grained access control. Detailed below.
Configuration block for the main user. Detailed below.
Configuration block for the Auto-Tune options of the domain. Detailed below.
Configuration block for the cluster of the domain. Detailed below.
Configuration block containing cold storage configuration. Detailed below.
Configuration block containing zone awareness settings. Detailed below.
Configuration block for authenticating dashboard with Cognito. Detailed below.
Configuration block for domain endpoint HTTP(S) related options. Detailed below.
Configuration block for EBS related options, may be required based on chosen instance size. Detailed below.
Configuration block for publishing slow and application logs to CloudWatch Logs. This block can be declared multiple times, for each log_type, within the same resource. Detailed below.
Reference to a Group in cloudwatchlogs to populate cloudwatchLogGroupArn.
Policies for referencing.
Selector for a Group in cloudwatchlogs to populate cloudwatchLogGroupArn.
Policies for selection.
Configuration block for node-to-node encryption options. Detailed below.
Configuration to add Off Peak update options. (documentation). Detailed below.
No description provided.
Configuration block for snapshot related options. Detailed below. DEPRECATED. For domains running OpenSearch 5.3 and later, Amazon OpenSearch takes hourly automated snapshots, making this setting irrelevant. For domains running earlier versions, OpenSearch takes daily automated snapshots.
Software update options for the domain. Detailed below.
Configuration block for VPC related options. Adding or removing this configuration forces a new resource (documentation). Detailed below.
List of VPC Security Group IDs to be applied to the OpenSearch domain endpoints. If omitted, the default Security Group for the VPC will be used.
List of VPC Subnet IDs for the OpenSearch domain endpoints to be created in.
THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
DomainStatus defines the observed state of Domain.
No description provided.
Configuration block for fine-grained access control. Detailed below.
Configuration block for the main user. Detailed below.
Configuration block for the Auto-Tune options of the domain. Detailed below.
Configuration block for the cluster of the domain. Detailed below.
Configuration block containing cold storage configuration. Detailed below.
Configuration block containing zone awareness settings. Detailed below.
Configuration block for authenticating dashboard with Cognito. Detailed below.
Configuration block for domain endpoint HTTP(S) related options. Detailed below.
Configuration block for EBS related options, may be required based on chosen instance size. Detailed below.
Configuration block for publishing slow and application logs to CloudWatch Logs. This block can be declared multiple times, for each log_type, within the same resource. Detailed below.
Configuration block for node-to-node encryption options. Detailed below.
Configuration to add Off Peak update options. (documentation). Detailed below.
No description provided.
Configuration block for snapshot related options. Detailed below. DEPRECATED. For domains running OpenSearch 5.3 and later, Amazon OpenSearch takes hourly automated snapshots, making this setting irrelevant. For domains running earlier versions, OpenSearch takes daily automated snapshots.
Software update options for the domain. Detailed below.
Configuration block for VPC related options. Adding or removing this configuration forces a new resource (documentation). Detailed below.
If the domain was created inside a VPC, the names of the availability zones the configured subnet_ids were created inside.
List of VPC Security Group IDs to be applied to the OpenSearch domain endpoints. If omitted, the default Security Group for the VPC will be used.
List of VPC Subnet IDs for the OpenSearch domain endpoints to be created in.
Conditions of the resource.
example
apiVersion: opensearch.aws.upbound.io/v1beta1
kind: Domain
metadata:
name: example
spec:
forProvider:
clusterConfig:
- instanceType: m4.large.search
domainName: example
ebsOptions:
- ebsEnabled: true
volumeSize: 10
volumeType: gp2
engineVersion: OpenSearch_1.0
region: us-west-1
example
apiVersion: opensearch.aws.upbound.io/v1beta1
kind: Domain
metadata:
annotations:
meta.upbound.io/example-id: opensearch/v1beta1/domain
labels:
testing.upbound.io/example-name: example
name: example
spec:
forProvider:
clusterConfig:
- instanceType: m4.large.search
domainName: example-domain-name
ebsOptions:
- ebsEnabled: true
volumeSize: 10
volumeType: gp2
engineVersion: OpenSearch_1.0
region: us-west-1
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.