Domain is the Schema for the Domains API
Type
CRD
Group
opensearchservice.aws.crossplane.io
Version
v1alpha1
apiVersion: opensearchservice.aws.crossplane.io/v1alpha1
kind: Domain
DomainSpec defines the desired state of Domain
DomainParameters defines the desired state of Domain
Options for fine-grained access control.
Credentials for the master user for a domain.
The SAML authentication configuration for an Amazon OpenSearch Service domain.
The SAML identity povider information.
Options for Auto-Tune.
No description provided.
The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html).
Container for the cluster configuration of a domain.
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).
The zone awareness configuration for an Amazon OpenSearch Service domain.
Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html).
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
Options for encryption of data at rest.
KMSKeyIDRef is a reference to a KMS Key used to set KMSKeyID.
Policies for referencing.
KMSKeyIDSelector selects a reference to a KMS Key used to set KMSKeyID.
Policies for selection.
Enables node-to-node encryption.
Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.
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.
For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html).
The desired start time for an off-peak maintenance window (https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html).
No description provided.
Software update options for the domain.
Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).
SecurityGroupIDRefs is a list of references to SecurityGroups used to set the SecurityGroupIDs.
Policies for referencing.
SecurityGroupIDsSelector selects references to SecurityGroupID used to set the SecurityGroupIDs.
Policies for selection.
No description provided.
SubnetIDRefs is a list of references to Subnets used to set the SubnetIDs.
Policies for referencing.
SubnetIDsSelector selects references to Subnets used to set the SubnetIDs.
Policies for selection.
SecurityGroupIDs is the list of IDs for the SecurityGroups.
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.
DomainObservation defines the observed state of Domain
Settings for fine-grained access control.
Describes the SAML application configured for the domain.
The SAML identity povider information.
Auto-Tune settings for the domain.
Container for the cluster configuration of the domain.
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).
The zone awareness configuration for an Amazon OpenSearch Service domain.
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
Whether node-to-node encryption is enabled or disabled.
The current status of the domain's service software.
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
The VPC configuration for the domain.
No description provided.
No description provided.
No description provided.
Conditions of the resource.
sample-domain
apiVersion: opensearchservice.aws.crossplane.io/v1alpha1
kind: Domain
metadata:
name: sample-domain
spec:
forProvider:
ebsOptions:
ebsEnabled: true
volumeSize: 10
volumeType: gp2
region: us-east-1
providerConfigRef:
name: example
sample2-domain
apiVersion: opensearchservice.aws.crossplane.io/v1alpha1
kind: Domain
metadata:
name: sample2-domain
spec:
forProvider:
clusterConfig:
instanceCount: 2
zoneAwarenessConfig:
availabilityZoneCount: 2
zoneAwarenessEnabled: true
ebsOptions:
ebsEnabled: true
volumeSize: 10
volumeType: gp2
encryptionAtRestOptions:
enabled: true
kmsKeyIdRef:
name: dev-key
region: us-east-1
vpcOptions:
securityGroupIdRefs:
- name: sample-cluster-sg-2
subnetIdRefs:
- name: sample-subnet1
- name: sample-subnet2
providerConfigRef:
name: example
writeConnectionSecretToRef:
name: sample2-domain
namespace: crossplane-system