CreateLocationSmb

서버 메시지 블록(SMB) 파일 서버의 전송 위치를 생성합니다.이 위치를 데이터 전송을 위한 소스 또는 대상으로 사용할 AWS DataSync 수 있습니다.

시작하기 전에 먼저 DataSync가 SMB 파일 서버에 액세스하는 방법을 이해해야 합니다. 자세한 내용은 DataSync에 SMB 파일 서버 액세스 권한 제공을 참조하세요.

구문 요청

{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosKeytab": blob,
   "KerberosKrb5Conf": blob,
   "KerberosPrincipal": "string",
   "MountOptions": { 
      "Version": "string"
   },
   "Password": "string",
   "ServerHostname": "string",
   "Subdirectory": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "User": "string"
}

요청 파라미터

모든 작업에 공통되는 파라미터에 대한 자세한 설명은 공통 파라미터를 참조하세요.

요청은 JSON 형식으로 다음 데이터를 받습니다.

AgentArns

SMB 파일 서버에 연결할 수 있는 DataSync 에이전트(또는 에이전트들)를 지정합니다. 에이전트의 Amazon 리소스 이름(ARN)을 사용하여 에이전트를 지정합니다.

타입: 문자열 배열

배열 구성원: 최소수는 1개입니다. 최대 항목 수는 8개입니다.

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

필수 여부: 예

AuthenticationType

DataSync가 SMB 파일 서버에 연결하는 데 사용하는 인증 프로토콜을 지정합니다. DataSync는 NTLM(기본값) 및 KERBEROS 인증을 지원합니다.

자세한 내용은 DataSync에 SMB 파일 서버 액세스 권한 제공을 참조하세요.

타입: 문자열

유효 값: NTLM | KERBEROS

필수 여부: 아니요

CmkSecretConfig

DataSync가 고객 관리형를 사용하여 특정 SMB 스토리지 위치에 액세스하는 데 사용하는 Password 또는 KerberosKeytab (각각 NTLM (기본값) 및 KERBEROS 인증 유형) 중 하나인 DataSync 관리형 보안 암호에 대한 구성 정보를 지정합니다 AWS KMS key.

이 파라미터를 CreateLocationSmbRequest 요청의 일부로 포함하는 경우 KMS 키 ARN만 제공합니다. DataSync는이 KMS 키를 Password 또는 KerberosKeytab 사용자가 지정한와 함께 사용하여 DataSync 관리형 보안 암호를 생성하여 위치 액세스 자격 증명을 저장합니다.

DataSync에 지정한 KMS 키에 액세스할 수 있는 권한이 있는지 확인합니다.

참고

CmkSecretConfig ( Password 또는 사용KerberosKeytab) 또는 CustomSecretConfig ( Password 및 사용 안 함KerberosKeytab)를 사용하여 CreateLocationSmbRequest 요청에 대한 자격 증명을 제공할 수 있습니다. 동일한 요청에 대해 CmkSecretConfig 및 CustomSecretConfig 파라미터를 모두 제공하지 마십시오.

유형: CmkSecretConfig객체

필수 여부: 아니요

CustomSecretConfig

SMB 스토리지 위치 보안 인증 정보가 Secrets Manager에 일반 텍스트(용) 또는 바이너리(용Password)로 저장되는 고객 관리형 Secrets Manager 보안 암호의 구성 정보를 지정합니다KerberosKeytab. 이 구성에는 보안 암호 ARN과 보안 암호에 대한 액세스를 제공하는 IAM 역할의 ARN이 포함됩니다.

참고

CmkSecretConfig(SasConfiguration 포함) 또는 CustomSecretConfig(SasConfiguration 제외)을 사용하여 CreateLocationSmbRequest 요청에 대한 자격 증명을 제공할 수 있습니다. 같은 요청에 대해 두 파라미터를 모두 제공하지 마세요.

유형: CustomSecretConfig객체

필수 여부: 아니요

DnsIpAddresses

SMB 파일 서버가 속한 DNS 서버의 IPv4 또는 IPv6 주소를 지정합니다. 이 파라미터는 AuthenticationType이 KERBEROS로 설정된 경우에만 적용됩니다.

환경에 여러 도메인이 있는 경우 이 파라미터를 구성하면 DataSync가 올바른 SMB 파일 서버에 연결되도록 할 수 있습니다.

유형: 문자열 배열

배열 멤버: 최대 항목 수는 2개입니다.

길이 제약: 최소 길이는 7입니다. 최대 길이는 39입니다.

패턴: \A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z

필수 여부: 아니요

Domain

SMB 파일 서버가 속한 Windows 도메인 이름을 지정합니다. 이 파라미터는 AuthenticationType이 NTLM로 설정된 경우에만 적용됩니다.

환경에 여러 도메인이 있는 경우 이 파라미터를 구성하면 DataSync가 올바른 파일 서버에 연결되도록 할 수 있습니다.

유형: 문자열

길이 제약: 최대 길이는 253입니다.

패턴: ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

필수 여부: 아니요

KerberosKeytab

Kerberos 보안 주체와 암호화 키 간의 매핑을 포함하는 Kerberos 키 테이블(keytab) 파일을 지정합니다.

작업 실행 오류를 방지하려면 키탭 파일을 생성하는 데 사용하는 Kerberos 보안 주체가 KerberosPrincipal에 지정한 것과 정확히 일치하는지 확인합니다.

타입: Base64로 인코딩된 이진 데이터 객체

길이 제약: 최대 길이는 65536입니다.

필수 여부: 아니요

KerberosKrb5Conf

Kerberos 영역 구성을 정의하는 Kerberos 구성 파일(krb5.conf)을 지정합니다.

파일은 반드시 base64로 인코딩되어야 합니다. 를 사용하는 경우 AWS CLI인코딩이 수행됩니다.

타입: Base64로 인코딩된 이진 데이터 객체

길이 제약: 최대 길이는 131072입니다.

필수 여부: 아니요

KerberosPrincipal

Kerberos 영역에서 SMB 파일 서버의 파일, 폴더, 파일 메타데이터에 액세스할 수 있는 권한을 가진 Kerberos 보안 주체를 지정합니다.

Kerberos 보안 주체는 HOST/[e-mail]처럼 보일 수 있습니다.

보안 주체 이름은 대/소문자를 구분합니다. 이 파라미터에 대해 지정한 보안 주체가 키탭 파일 생성에 사용하는 보안 주체와 정확히 일치하지 않으면 DataSync 작업 실행이 실패합니다.

유형: 문자열

길이 제약 조건: 최소 길이는 1입니다. 최대 길이는 256입니다.

패턴: ^.+$

필수 여부: 아니요

MountOptions

DataSync가 SMB 파일 서버에 액세스하는 데 사용하는 SMB 프로토콜의 버전을 지정합니다.

타입: SmbMountOptions객체

필수 여부: 아니요

Password

사용자 SMB 파일 서버를 탑재하고 전송과 관련된 파일과 폴더에 액세스할 수 있는 권한이 있는 사용자의 암호를 지정합니다. 이 파라미터는 AuthenticationType이 NTLM로 설정된 경우에만 적용됩니다.

유형: 문자열

길이 제약: 최대 길이는 104입니다.

패턴: ^.{0,104}$

필수 여부: 아니요

ServerHostname

DataSync 에이전트가 연결될 SMB 파일 서버의 도메인 이름 또는 IP 주소(IPv4 또는 IPv6)를 지정합니다.

참고

Kerberos 인증을 사용하는 경우 도메인 이름을 지정해야 합니다.

유형: 문자열

길이 제약: 최대 길이는 255입니다.

패턴: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$

필수 여부: 예

Subdirectory

DataSync가 데이터를 읽거나 쓸 SMB 파일 서버에서 내보낸 공유의 이름을 지정합니다. 공유 경로에 하위 디렉토리(예: /path/to/subdirectory)를 포함할 수 있습니다. 네트워크의 다른 SMB 클라이언트도 이 경로를 마운트할 수 있는지 확인하세요.

하위 디렉터리의 모든 데이터를 복사하려면 DataSync가 SMB 공유를 마운트하고 모든 데이터에 액세스할 수 있어야 합니다. 자세한 내용은 DataSync에 SMB 파일 서버 액세스 권한 제공을 참조하세요.

유형: 문자열

길이 제약: 최대 길이는 4096입니다.

패턴: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

필수 여부: 예

Tags

AWS 리소스를 분류, 필터링 및 검색하는 데 도움이 되는 레이블을 지정합니다. 위치에 대한 이름 태그를 하나 이상 생성하는 것이 좋습니다.

타입: TagListEntry객체 배열

배열 구성원: 최소수는 0개입니다. 최대수 50개.

필수 여부: 아니요

User

SMB 파일 서버의 파일, 폴더, 파일 메타데이터를 탑재하고 액세스할 수 있는 사용자를 지정합니다. 이 파라미터는 AuthenticationType이 NTLM로 설정된 경우에만 적용됩니다.

전송에 적합한 수준의 액세스 권한을 가진 사용자를 선택하는 방법에 대한 자세한 내용은 SMB 파일 서버에 대한 DataSync 액세스 제공을 참조하세요.

유형: 문자열

길이 제약: 최대 길이는 104입니다.

패턴: ^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$

필수 여부: 아니요

응답 구문

{
   "LocationArn": "string"
}

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

LocationArn

귀하가 생성한 SMB 위치의 ARN입니다.

타입: 문자열

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

오류

모든 작업에서 공통적으로 발생하는 오류에 대한 자세한 설명은 일반적인 오류섹션을 참조하세요.

InternalException

이 예외는 AWS DataSync 서비스에 오류가 발생할 때 던져집니다.

HTTP 상태 코드: 500

InvalidRequestException

이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.

HTTP 상태 코드: 400

예

예 요청

다음 예에서는 SMB 파일 서버의 위치를 생성합니다.

{
   "AgentArns":[
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs",
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3"
   ],
   "Domain":"AMAZON",
   "MountOptions":{
      "Version":"SMB3"
   },
   "Password":"string",
   "ServerHostname":"MyServer.amazon.com",
   "Subdirectory":"share",
   "Tags":[
      {
         "Key":"department",
         "Value":"finance"
      }
   ],
   "User":"user-1"
}

샘플 응답

응답은 SMB 파일 서버의 위치 ARN을 반환합니다.

{
    "LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}

참고

언어별 AWS SDKs

• AWS 명령줄 인터페이스 V2

• AWS SDK for .NET

• AWS SDK for C++

• AWS Go용 SDK v2

• AWS Java V2용 SDK

• AWS SDK for JavaScript V3

• AWS SDK for Kotlin

• AWS PHP V3용 SDK

• AWS Python용 SDK

• AWS SDK for Ruby V3