사용자 지정 리소스 응답 객체
이 주제에서는 CloudFormation 사용자 지정 리소스에 대한 응답 객체의 속성을 설명합니다.
사용자 지정 리소스의 소개와 작동 방식은 사용자 지정 리소스를 사용하여 사용자 지정 프로비저닝 로직 생성 섹션을 참조하세요.
사용자 지정 리소스 공급자 응답 필드
다음은 JSON 파일을 미리 서명된 URL로 전송할 때 사용자 지정 리소스 공급자에 포함되는 속성입니다. 미리 서명된 URL을 사용하여 객체를 업로드하는 방법에 대한 자세한 내용을 알아보려면 Amazon Simple Storage Service 사용 설명서의 관련 주제를 참조하세요.
참고
응답 본문의 총 크기는 4,096바이트를 초과할 수 없습니다.
Status
-
AWS CloudFormation에서 생성한 요청에 대해 사용자 지정 리소스 공급자가 보낸 상태 값.
SUCCESS
또는FAILED
여야 합니다.필수 항목 여부: 예
유형: 문자열
Reason
-
실패 응답의 이유를 설명합니다.
필수:
Status
가FAILED
인 경우 필수입니다. 그렇지 않은 경우 선택 사항입니다.유형: 문자열
PhysicalResourceId
이 값은 사용자 지정 리소스 공급업체 고유의 ID여야 하며, 크기는 최대 1KB까지 가능합니다. 값은 빈 문자열일 수 없으며, 동일한 리소스의 모든 응답에 대해 동일해야 합니다.
PhysicalResourceId
에 대해 반환된 값은 사용자 지정 리소스 업데이트 작업을 변경할 수 있습니다. 반환된 값이 같은 경우 일반 업데이트로 간주됩니다. 반환된 값이 다른 경우 AWS CloudFormation은 업데이트를 교체로 인식하고 기존 리소스에 삭제 요청을 전송합니다. 자세한 내용은AWS::CloudFormation::CustomResource
단원을 참조하십시오.필수 항목 여부: 예
유형: 문자열
StackId
-
사용자 지정 리소스가 들어 있는 스택을 나타내는 Amazon 리소스 이름(ARN). 이 응답 값은 요청에서 그대로 복사해야 합니다.
필수 항목 여부: 예
유형: 문자열
RequestId
-
요청에 대한 고유 ID입니다. 이 응답 값은 요청에서 그대로 복사해야 합니다.
필수 항목 여부: 예
유형: 문자열
LogicalResourceId
-
AWS CloudFormation 템플릿에 있는 사용자 지정 리소스의 템플릿 개발자 선택 이름(논리적 ID). 이 응답 값은 요청에서 그대로 복사해야 합니다.
필수 항목 여부: 예
유형: 문자열
NoEcho
-
선택 사항입니다.
Fn::GetAtt
함수를 사용하여 조회할 때 사용자 지정 리소스의 출력을 마스킹할지 여부를 나타냅니다.true
로 설정하면 템플릿의Metadata
섹션에 저장된 값을 제외하고 반환된 모든 값이 별표(*****)로 마스킹됩니다. AWS CloudFormation은Metadata
섹션에 포함된 정보를 변환, 수정 또는 삭제하지 않습니다. 기본값은false
입니다.NoEcho
를 사용하여 민감한 정보를 마스킹 처리하는 방법에 대한 자세한 내용은 템플릿에 자격 증명을 포함하지 않음 모범 사례를 참조하세요.필수 항목 여부: 아니요
유형: 부울
Data
-
선택 사항입니다. 응답과 함께 보낼 사용자 지정 리소스 공급자 정의 이름-값 페어.
Fn::GetAtt
와 템플릿의 이름을 사용해 여기 제공된 값에 액세스할 수 있습니다.중요
이름-값 페어에 중요한 정보가 들어 있는 경우
NoEcho
필드를 사용하여 사용자 지정 리소스의 출력을 마스킹해야 합니다. 그러지 않으면 속성값(예:DescribeStackEvents
)을 드러내는 API를 통해 값이 표시될 수 있습니다.필수 항목 여부: 아니요
유형: JSON 객체