# AWS CLI를 사용한 OpenSearch 서비스 예제
다음 코드 예제에서는 OpenSearch Service에서 AWS Command Line Interface를 사용하여 작업을 수행하고 일반적인 시나리오를 구현하는 방법을 보여 줍니다.
*작업*은 대규모 프로그램에서 발췌한 코드이며 컨텍스트에 맞춰 실행해야 합니다. 작업은 개별 서비스 함수를 직접적으로 호출하는 방법을 보여주며 관련 시나리오의 컨텍스트에 맞는 작업을 볼 수 있습니다.
각 예시에는 전체 소스 코드에 대한 링크가 포함되어 있으며, 여기에서 컨텍스트에 맞춰 코드를 설정하고 실행하는 방법에 대한 지침을 찾을 수 있습니다.
**Topics**
+ [작업](#actions)
## 작업
### `create-elasticsearch-domain`
다음 코드 예시는 `create-elasticsearch-domain`의 사용 방법을 보여줍니다.
**AWS CLI**
**데이터를 Amazon Elasticsearch Service 도메인에 작성하는 방법**
다음 `create-elasticsearch-domain` 명령은 VPC 내에 새 Amazon Elasticsearch Service 도메인을 생성하고 단일 사용자로 액세스를 제한합니다. Amazon ES는 지정된 서브넷 및 보안 그룹 ID에서 VPC ID를 추론합니다.
```
aws es create-elasticsearch-domain \
--domain-name vpc-cli-example \
--elasticsearch-version 6.2 \
--elasticsearch-cluster-config InstanceType=m4.large.elasticsearch,InstanceCount=1 \
--ebs-options EBSEnabled=true,VolumeType=standard,VolumeSize=10 \
--access-policies '{"Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:root" }, "Action":"es:*", "Resource": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*" } ] }' \
--vpc-options SubnetIds=subnet-1a2a3a4a,SecurityGroupIds=sg-2a3a4a5a
```
출력:
```
{
"DomainStatus": {
"ElasticsearchClusterConfig": {
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"ZoneAwarenessEnabled": false,
"InstanceType": "m4.large.elasticsearch"
},
"DomainId": "123456789012/vpc-cli-example",
"CognitoOptions": {
"Enabled": false
},
"VPCOptions": {
"SubnetIds": [
"subnet-1a2a3a4a"
],
"VPCId": "vpc-3a4a5a6a",
"SecurityGroupIds": [
"sg-2a3a4a5a"
],
"AvailabilityZones": [
"us-west-1c"
]
},
"Created": true,
"Deleted": false,
"EBSOptions": {
"VolumeSize": 10,
"VolumeType": "standard",
"EBSEnabled": true
},
"Processing": true,
"DomainName": "vpc-cli-example",
"SnapshotOptions": {
"AutomatedSnapshotStartHour": 0
},
"ElasticsearchVersion": "6.2",
"AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*\"}]}",
"AdvancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
},
"EncryptionAtRestOptions": {
"Enabled": false
},
"ARN": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example"
}
}
```
자세한 내용은 *Amazon Elasticsearch Service 개발자 안내서*의 [Amazon Elasticsearch Service 도메인 생성 및 관리](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)를 참조하세요.
+ API 세부 정보는 *AWS CLI 명령 참조*의 [CreateElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/create-elasticsearch-domain.html)을 참조하세요.
### `describe-elasticsearch-domain-config`
다음 코드 예시는 `describe-elasticsearch-domain-config`의 사용 방법을 보여줍니다.
**AWS CLI**
**도메인 구성 세부 정보를 얻는 방법**
다음 `describe-elasticsearch-domain-config` 예제에서는 각 개별 도메인 구성 요소에 대한 상태 정보와 함께 지정된 도메인에 대한 구성 세부 정보를 제공합니다.
```
aws es describe-elasticsearch-domain-config \
--domain-name cli-example
```
출력:
```
{
"DomainConfig": {
"ElasticsearchVersion": {
"Options": "7.4",
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"ElasticsearchClusterConfig": {
"Options": {
"InstanceType": "c5.large.elasticsearch",
"InstanceCount": 1,
"DedicatedMasterEnabled": true,
"ZoneAwarenessEnabled": false,
"DedicatedMasterType": "c5.large.elasticsearch",
"DedicatedMasterCount": 3,
"WarmEnabled": true,
"WarmType": "ultrawarm1.medium.elasticsearch",
"WarmCount": 2
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"EBSOptions": {
"Options": {
"EBSEnabled": true,
"VolumeType": "gp2",
"VolumeSize": 10
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"AccessPolicies": {
"Options": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example/*\"}]}",
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"SnapshotOptions": {
"Options": {
"AutomatedSnapshotStartHour": 0
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"VPCOptions": {
"Options": {},
"Status": {
"CreationDate": 1591210426.162,
"UpdateDate": 1591210426.162,
"UpdateVersion": 18,
"State": "Active",
"PendingDeletion": false
}
},
"CognitoOptions": {
"Options": {
"Enabled": false
},
"Status": {
"CreationDate": 1591210426.163,
"UpdateDate": 1591210426.163,
"UpdateVersion": 18,
"State": "Active",
"PendingDeletion": false
}
},
"EncryptionAtRestOptions": {
"Options": {
"Enabled": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a"
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"NodeToNodeEncryptionOptions": {
"Options": {
"Enabled": true
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"AdvancedOptions": {
"Options": {
"rest.action.multi.allow_explicit_index": "true"
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"LogPublishingOptions": {
"Options": {},
"Status": {
"CreationDate": 1591210426.164,
"UpdateDate": 1591210426.164,
"UpdateVersion": 18,
"State": "Active",
"PendingDeletion": false
}
},
"DomainEndpointOptions": {
"Options": {
"EnforceHTTPS": true,
"TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589395827.325,
"UpdateVersion": 8,
"State": "Active",
"PendingDeletion": false
}
},
"AdvancedSecurityOptions": {
"Options": {
"Enabled": true,
"InternalUserDatabaseEnabled": true
},
"Status": {
"CreationDate": 1589395034.946,
"UpdateDate": 1589827485.577,
"UpdateVersion": 14,
"State": "Active",
"PendingDeletion": false
}
}
}
}
```
자세한 내용은 *Amazon Elasticsearch Service 개발자 안내서*의 [Amazon Elasticsearch Service 도메인 생성 및 관리](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)를 참조하세요.
+ API 세부 정보는 *AWS CLI 명령 참조*의 [DescribeElasticsearchDomainConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain-config.html)를 참조하세요.
### `describe-elasticsearch-domain`
다음 코드 예시는 `describe-elasticsearch-domain`의 사용 방법을 보여줍니다.
**AWS CLI**
**단일 도메인에 대한 세부 정보를 얻는 방법**
다음 `describe-elasticsearch-domain` 예제에서는 주어진 도메인에 대한 구성 세부 정보를 제공합니다.
```
aws es describe-elasticsearch-domain \
--domain-name cli-example
```
출력:
```
{
"DomainStatus": {
"DomainId": "123456789012/cli-example",
"DomainName": "cli-example",
"ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example",
"Created": true,
"Deleted": false,
"Endpoint": "search-cli-example-1a2a3a4a5a6a7a8a9a0a.us-east-1.es.amazonaws.com",
"Processing": false,
"UpgradeProcessing": false,
"ElasticsearchVersion": "7.4",
"ElasticsearchClusterConfig": {
"InstanceType": "c5.large.elasticsearch",
"InstanceCount": 1,
"DedicatedMasterEnabled": true,
"ZoneAwarenessEnabled": false,
"DedicatedMasterType": "c5.large.elasticsearch",
"DedicatedMasterCount": 3,
"WarmEnabled": true,
"WarmType": "ultrawarm1.medium.elasticsearch",
"WarmCount": 2
},
"EBSOptions": {
"EBSEnabled": true,
"VolumeType": "gp2",
"VolumeSize": 10
},
"AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example/*\"}]}",
"SnapshotOptions": {
"AutomatedSnapshotStartHour": 0
},
"CognitoOptions": {
"Enabled": false
},
"EncryptionAtRestOptions": {
"Enabled": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a"
},
"NodeToNodeEncryptionOptions": {
"Enabled": true
},
"AdvancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
},
"ServiceSoftwareOptions": {
"CurrentVersion": "R20200522",
"NewVersion": "",
"UpdateAvailable": false,
"Cancellable": false,
"UpdateStatus": "COMPLETED",
"Description": "There is no software update available for this domain.",
"AutomatedUpdateDate": 0.0
},
"DomainEndpointOptions": {
"EnforceHTTPS": true,
"TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
},
"AdvancedSecurityOptions": {
"Enabled": true,
"InternalUserDatabaseEnabled": true
}
}
}
```
자세한 내용은 *Amazon Elasticsearch Service 개발자 안내서*의 [Amazon Elasticsearch Service 도메인 생성 및 관리](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)를 참조하세요.
+ API 세부 정보는 *AWS CLI 명령 참조*의 [DescribeElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain.html)을 참조하세요.
### `describe-elasticsearch-domains`
다음 코드 예시는 `describe-elasticsearch-domains`의 사용 방법을 보여줍니다.
**AWS CLI**
**하나 이상의 도메인에 대한 세부 정보를 얻는 방법**
다음 `describe-elasticsearch-domains` 예제에서는 하나 이상의 도메인에 대한 구성 세부 정보를 제공합니다.
```
aws es describe-elasticsearch-domains \
--domain-names cli-example-1 cli-example-2
```
출력:
```
{
"DomainStatusList": [{
"DomainId": "123456789012/cli-example-1",
"DomainName": "cli-example-1",
"ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example-1",
"Created": true,
"Deleted": false,
"Endpoint": "search-cli-example-1-1a2a3a4a5a6a7a8a9a0a.us-east-1.es.amazonaws.com",
"Processing": false,
"UpgradeProcessing": false,
"ElasticsearchVersion": "7.4",
"ElasticsearchClusterConfig": {
"InstanceType": "c5.large.elasticsearch",
"InstanceCount": 1,
"DedicatedMasterEnabled": true,
"ZoneAwarenessEnabled": false,
"DedicatedMasterType": "c5.large.elasticsearch",
"DedicatedMasterCount": 3,
"WarmEnabled": true,
"WarmType": "ultrawarm1.medium.elasticsearch",
"WarmCount": 2
},
"EBSOptions": {
"EBSEnabled": true,
"VolumeType": "gp2",
"VolumeSize": 10
},
"AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example-1/*\"}]}",
"SnapshotOptions": {
"AutomatedSnapshotStartHour": 0
},
"CognitoOptions": {
"Enabled": false
},
"EncryptionAtRestOptions": {
"Enabled": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/1a2a3a4a-1a2a-1a2a-1a2a-1a2a3a4a5a6a"
},
"NodeToNodeEncryptionOptions": {
"Enabled": true
},
"AdvancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
},
"ServiceSoftwareOptions": {
"CurrentVersion": "R20200522",
"NewVersion": "",
"UpdateAvailable": false,
"Cancellable": false,
"UpdateStatus": "COMPLETED",
"Description": "There is no software update available for this domain.",
"AutomatedUpdateDate": 0.0
},
"DomainEndpointOptions": {
"EnforceHTTPS": true,
"TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
},
"AdvancedSecurityOptions": {
"Enabled": true,
"InternalUserDatabaseEnabled": true
}
},
{
"DomainId": "123456789012/cli-example-2",
"DomainName": "cli-example-2",
"ARN": "arn:aws:es:us-east-1:123456789012:domain/cli-example-2",
"Created": true,
"Deleted": false,
"Processing": true,
"UpgradeProcessing": false,
"ElasticsearchVersion": "7.4",
"ElasticsearchClusterConfig": {
"InstanceType": "r5.large.elasticsearch",
"InstanceCount": 1,
"DedicatedMasterEnabled": false,
"ZoneAwarenessEnabled": false,
"WarmEnabled": false
},
"EBSOptions": {
"EBSEnabled": true,
"VolumeType": "gp2",
"VolumeSize": 10
},
"AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/cli-example-2/*\"}]}",
"SnapshotOptions": {
"AutomatedSnapshotStartHour": 0
},
"CognitoOptions": {
"Enabled": false
},
"EncryptionAtRestOptions": {
"Enabled": false
},
"NodeToNodeEncryptionOptions": {
"Enabled": false
},
"AdvancedOptions": {
"rest.action.multi.allow_explicit_index": "true"
},
"ServiceSoftwareOptions": {
"CurrentVersion": "",
"NewVersion": "",
"UpdateAvailable": false,
"Cancellable": false,
"UpdateStatus": "COMPLETED",
"Description": "There is no software update available for this domain.",
"AutomatedUpdateDate": 0.0
},
"DomainEndpointOptions": {
"EnforceHTTPS": false,
"TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07"
},
"AdvancedSecurityOptions": {
"Enabled": false,
"InternalUserDatabaseEnabled": false
}
}
]
}
```
자세한 내용은 *Amazon Elasticsearch Service 개발자 안내서*의 [Amazon Elasticsearch Service 도메인 생성 및 관리](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)를 참조하세요.
+ API 세부 정보는 *AWS CLI 명령 참조*의 [DescribeElasticsearchDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domains.html)를 참조하세요.
### `describe-reserved-elasticsearch-instances`
다음 코드 예시는 `describe-reserved-elasticsearch-instances`의 사용 방법을 보여줍니다.
**AWS CLI**
**예약된 모든 인스턴스를 보는 방법**
다음 `describe-elasticsearch-domains` 예제에서는 리전에서 예약한 모든 인스턴스의 요약을 제공합니다.
```
aws es describe-reserved-elasticsearch-instances
```
출력:
```
{
"ReservedElasticsearchInstances": [{
"FixedPrice": 100.0,
"ReservedElasticsearchInstanceOfferingId": "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a",
"ReservationName": "my-reservation",
"PaymentOption": "PARTIAL_UPFRONT",
"UsagePrice": 0.0,
"ReservedElasticsearchInstanceId": "9a8a7a6a-5a4a-3a2a-1a0a-9a8a7a6a5a4a",
"RecurringCharges": [{
"RecurringChargeAmount": 0.603,
"RecurringChargeFrequency": "Hourly"
}],
"State": "payment-pending",
"StartTime": 1522872571.229,
"ElasticsearchInstanceCount": 3,
"Duration": 31536000,
"ElasticsearchInstanceType": "m4.2xlarge.elasticsearch",
"CurrencyCode": "USD"
}]
}
```
자세한 내용은 *Amazon Elasticsearch Service 개발자 안내서*의 [예약형 인스턴스](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-ri.html)를 참조하세요.
+ API 세부 정보는 *AWS CLI 명령 참조*의 [DescribeReservedElasticsearchInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-reserved-elasticsearch-instances.html)를 참조하세요.
### `list-domain-names`
다음 코드 예시는 `list-domain-names`의 사용 방법을 보여줍니다.
**AWS CLI**
**도메인 목록을 표시하는 방법**
다음 `list-domain-names` 예제에서는 리전 내 모든 도메인에 대한 간략한 요약을 제공합니다.
```
aws es list-domain-names
```
출력:
```
{
"DomainNames": [{
"DomainName": "cli-example-1"
},
{
"DomainName": "cli-example-2"
}
]
}
```
자세한 내용은 *Amazon Elasticsearch Service 개발자 안내서*의 [Amazon Elasticsearch Service 도메인 생성 및 관리](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)를 참조하세요.
+ API 세부 정보는 *AWS CLI 명령 참조*의 [ListDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/list-domain-names.html)를 참조하세요.