렌즈 형식 사양 - AWS Well-Architected Tool

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

렌즈 형식 사양

렌즈는 특정 JSON 형식을 사용하여 정의됩니다. 사용자 지정 렌즈를 만들기 시작하면 템플릿 JSON 파일을 다운로드할 수 있습니다. 기둥, 질문, 모범 사례 및 개선 계획의 기본 구조를 정의하므로 이 파일을 사용자 지정 렌즈의 기초로 사용할 수 있습니다.

렌즈 섹션

이 섹션에서는 사용자 정의 렌즈 자체의 속성을 정의합니다. 이름 및 설명입니다.

  • schemaVersion: 사용할 사용자 지정 렌즈 스키마의 버전입니다. 템플릿으로 설정하면 변경하지 마십시오.

  • name: 렌즈 이름입니다. 이름은 최대 128자까지 지정할 수 있습니다.

  • description: 렌즈의 텍스트 설명입니다. 이 텍스트는 워크로드를 생성하는 동안 추가할 렌즈를 선택하거나 나중에 기존 작업 부하에 적용할 렌즈를 선택할 때 표시됩니다. 설명은 최대 2,048자입니다.

"schemaVersion": "2021-11-01", "name": "Company Policy ABC", "description": "This lens provides a set of specific questions to assess compliance with company policy ABC-2021 as revised on 2021/09/01.",

기둥 섹션

이 섹션에서는 사용자 정의 렌즈와 관련된 기둥을 정의합니다. 질문의 기둥에 매핑할 수 있습니다.AWSWell-Architected 프레임워크, 자신 만의 기둥 또는 둘 다를 정의하십시오.

사용자 지정 렌즈에는 최대 10개의 기둥을 정의할 수 있습니다.

  • id: 기둥의 ID입니다. ID는 3~128자일 수 있으며 영숫자 및 밑줄 ('_') 문자만 포함할 수 있습니다. 기둥에 사용되는 ID는 고유해야 합니다.

  • name: 기둥의 이름입니다. 이름은 최대 128자까지 지정할 수 있습니다.

"pillars": [ { "id": "company_Privacy", "name": "Privacy Excellence", . . . }, { "id": "company_Security", "name": "Security", . . . } ]

질문 섹션

이 섹션에서는 기둥과 관련된 질문을 정의합니다.

사용자 지정 렌즈의 기둥에 질문을 최대 20개까지 정의할 수 있습니다.

  • id: 질문에 대한 ID입니다. ID는 3~128자일 수 있으며 영숫자 및 밑줄 ('_') 문자만 포함할 수 있습니다. 문제에 사용된 ID는 고유해야 합니다.

  • title: 질문 제목. 제목은 최대 128자까지 지정할 수 있습니다.

  • description: 질문에 대해 자세히 설명합니다. 설명은 최대 2,048자입니다.

  • helpfulResource displayText: 선택 사항입니다. 질문에 대한 유용한 정보를 제공하는 텍스트입니다. 텍스트는 최대 2,048자입니다. 다음 경우에 지정해야 합니다.helpfulResource url가 지정됩니다.

  • helpfulResource url: 선택 사항입니다. 질문을 더 자세히 설명하는 URL 리소스입니다. URL은 로 시작해야 합니다.http://또는https://.

"questions": [ { "id": "privacy01", "title": "How do you ensure HR conversations are private?", "description": "Career and benefits discussions should occur on secure channels only and be audited regularly for compliance.", "helpfulResource": { "displayText": "This is helpful text for the first question", "url": "https://example.com/poptquest01_help.html" }, . . . }, { "id": "privacy02", "title": "Is your team following the company privacy policy?", "description": "Our company requires customers to opt-in to data use and does not disclose customer data to third parties either individually or in aggregate.", "helpfulResource": { "displayText": "This is helpful text for the second question", "url": "https://example.com/poptquest02_help.html" }, . . . } ]

선택 섹션

이 섹션에서는 질문과 관련된 선택 항목을 정의합니다.

사용자 지정 렌즈에서 문제에 대해 최대 15가지 선택 항목을 정의할 수 있습니다.

  • id: 선택한 ID입니다. ID는 3~128자일 수 있으며 영숫자 및 밑줄 ('_') 문자만 포함할 수 있습니다. 선택 항목에 사용된 ID는 고유해야 합니다. 접미사가 다음 인 선택 항목 추가_noa로 작용할 것입니다.None of these질문에 대한 선택.

  • title: 선택 제목. 제목은 최대 128자까지 지정할 수 있습니다.

  • description: 선택 사항입니다. 선택 사항에 대해 자세히 설명합니다. 설명은 최대 2,048자입니다.

  • helpfulResource displayText: 선택 사항입니다. 선택 항목에 대한 유용한 정보를 제공하는 텍스트입니다. 텍스트는 최대 2,048자입니다. 다음과 같은 경우 포함되어야 합니다helpfulResource url가 지정됩니다.

  • helpfulResource url: 선택 사항입니다. 선택 사항에 대해 자세히 설명하는 URL 리소스입니다. URL은 로 시작해야 합니다.http://또는https://.

  • improvementPlan displayText: 선택 항목을 개선할 수 있는 방법을 설명하는 텍스트입니다. 텍스트는 최대 2,048자입니다. 원래 요청 ping에 대한improvementPlan각 선택에 대해 이 (가) 필요합니다.

  • improvementPlan url: 선택 사항입니다. 개선에 도움이 될 수 있는 URL 리소스입니다. URL은 로 시작해야 합니다.http://또는https://.

"choices": [ { "id": "choice_1", "title": "Option 1", "helpfulResource": { "displayText": "This is helpful text for the first choice", "url": "https://example.com/popt01_help.html" }, "improvementPlan": { "displayText": "This is text that will be shown for improvement of this choice.", "url": "https://example.com/popt01_iplan.html" } }, { "id": "choice_2", "title": "Option 2", "helpfulResource": { "displayText": "This is helpful text for the second choice", "url": "https://example.com/hr_manual_CORP.pdf" }, "improvementPlan": { "displayText": "This is text that will be shown for improvement of this choice.", "url": "https://example.com/popt02_iplan.html" } },

위험 규칙 섹션

이 섹션에서는 선택한 선택 항목이 위험 수준을 결정하는 방법을 정의합니다.

각 위험 수준에 대해 하나씩 질문당 최대 3개의 위험 규칙을 정의할 수 있습니다.

  • condition: 질문에 대한 위험 수준에 매핑되는 선택 항목의 부울 표현식default.

    이 있어야 합니다.default각 질문마다 위험 규칙.

  • risk: 조건과 관련된 위험을 나타냅니다. 유횻값은 HIGH_RISK, MEDIUM_RISK, NO_RISK입니다.

위험 규칙의 순서는 중요합니다. 첫 번째condition다음과 같이 평가됩니다.true질문에 대한 위험을 설정합니다. 위험 규칙을 구현하기 위한 일반적인 패턴은 가장 위험도가 낮은 (일반적으로 가장 세분화된) 규칙부터 시작하여 가장 위험한 (그리고 가장 구체적이지 않은) 규칙으로 나아가는 것입니다.

예:

"riskRules": [ { "condition": "choice_1 && choice_2 && choice_3", "risk": "NO_RISK" }, { "condition": "((choice_1 || choice_2) && choice_3) || (!choice_1 && choice_3)", "risk": "MEDIUM_RISK" }, { "condition": "default", "risk": "HIGH_RISK" } ]

질문에 세 가지 선택 사항이 있는 경우 (choice_1,choice_2, 및choice_3) 에서 이러한 위험 규칙으로 인해 다음과 같은 동작이 발생합니다.

  • 세 가지 선택 항목을 모두 선택하면 위험은 없습니다.

  • 어느 쪽이든choice_1또는choice_2가 선택됨 choice_3이 선택되면 중간 정도의 위험이 있습니다.

  • 다음의 경우,choice_1입니다아니Selectedchoice_3이 선택되면 중간 정도의 위험이 있습니다.

  • 이러한 이전 조건 중 어느 것도 해당되지 않으면 위험이 높습니다.