Sezione Obiettivi Sezione Pilastri Sezione Domande Sezione Scelte Sezione Regole di rischio

Specificazione del formato delle lenti in AWS WA Tool

Le lenti sono definite utilizzando un JSON formato specifico. Quando inizi a creare un obiettivo personalizzato, hai la possibilità di scaricare un JSON file modello. Puoi utilizzare questo file come base per le tue lenti personalizzate in quanto definisce la struttura di base per i pilastri, le domande, le migliori pratiche e il piano di miglioramento.

Sezione Obiettivi

Questa sezione definisce gli attributi per l'obiettivo personalizzato stesso. Questo è il nome e la descrizione.

schemaVersion: La versione dello schema di obiettivo personalizzato da utilizzare. Impostata in base al modello, non modificare.
name: nome dell'obiettivo. Il nome può contenere fino a 128 caratteri.
description: Descrizione testuale dell'obiettivo. Questo testo viene visualizzato quando si selezionano gli obiettivi da aggiungere durante la creazione del carico di lavoro o quando si seleziona un obiettivo da applicare successivamente a un carico di lavoro esistente. La descrizione può contenere fino a 2048 caratteri.


    "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.",

Sezione Pilastri

Questa sezione definisce i pilastri associati all'obiettivo personalizzato. Puoi mappare le tue domande sui pilastri del AWS Well-Architected Framework, definire i tuoi pilastri o entrambi.

È possibile definire fino a 10 pilastri in un obiettivo personalizzato.

id: ID per il pilastro. L'ID può contenere da 3 a 128 caratteri e contenere solo caratteri alfanumerici e caratteri di sottolineatura («_»). L'elemento IDs utilizzato in un pilastro deve essere unico.

Quando associ le tue domande ai pilastri del Framework, usa quanto segue: IDs
- operationalExcellence
- security
- reliability
- performance
- costOptimization
- sustainability
name: Nome del pilastro. Il nome può contenere fino a 128 caratteri.


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

Sezione Domande

Questa sezione definisce le domande associate a un pilastro.

Puoi definire fino a 20 domande in un pilastro in una lente personalizzata.

id: ID per la domanda. L'ID può contenere da 3 a 128 caratteri e contenere solo caratteri alfanumerici e caratteri di sottolineatura («_»). L'elemento IDs usato in una domanda deve essere unico.
title: Titolo della domanda. Il titolo può contenere fino a 128 caratteri.
description: descrive la domanda in modo più dettagliato. La descrizione può contenere fino a 2048 caratteri.
helpfulResource displayText: facoltativo. Testo che fornisce informazioni utili sulla domanda. Il testo può contenere fino a 2048 caratteri. Deve essere specificato se helpfulResource url è specificato.
helpfulResource url: facoltativo. Una URL risorsa che spiega la domanda in modo più dettagliato. URLDeve iniziare con http:// ohttps://.

Nota

Quando sincronizzi il carico di lavoro di un obiettivo personalizzato con Jira, le domande mostrano sia l' «id» che il «titolo» della domanda.

Il formato utilizzato nei ticket Jira è. [ QuestionID ] QuestionTitle


"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"
        },
        .
        .
        .
    }
]

Sezione Scelte

Questa sezione definisce le scelte associate a una domanda.

Puoi definire fino a 15 scelte per una domanda in un obiettivo personalizzato.

id: ID per la scelta. L'ID può essere compreso tra 3 e 128 caratteri e contenere solo caratteri alfanumerici e caratteri di sottolineatura («_»). È necessario specificare un ID univoco per ogni scelta in una domanda. L'aggiunta di una scelta con il suffisso di _no fungerà da None of these scelta per la domanda.
title: Titolo della scelta. Il titolo può contenere fino a 128 caratteri.
helpfulResource displayText: facoltativo. Testo che fornisce informazioni utili su una scelta. Il testo può contenere fino a 2048 caratteri. Deve essere incluso se helpfulResource url specificato.
helpfulResource url: facoltativo. Una URL risorsa che spiega la scelta in modo più dettagliato. URLDeve iniziare con http:// ohttps://.
improvementPlan displayText: Testo che descrive come migliorare una scelta. Il testo può contenere fino a 2048 caratteri. Un improvementPlan è obbligatorio per ogni scelta, ad eccezione di una None of these scelta.
improvementPlan url: facoltativo. Una URL risorsa che può contribuire al miglioramento. URLDeve iniziare con http:// ohttps://.
additionalResources type: facoltativo. Il tipo di risorse aggiuntive. Il valore può essere uno dei due HELPFUL_RESOURCEIMPROVEMENT_PLAN.
additionalResources content: facoltativo. Speciifica i url valori displayText e per la risorsa aggiuntiva. A scelta è possibile specificare fino a cinque risorse utili aggiuntive e fino a cinque elementi aggiuntivi del piano di miglioramento.
- displayText: facoltativo. Testo che descrive la risorsa utile o il piano di miglioramento. Il testo può contenere fino a 2048 caratteri. Deve essere incluso se url specificato.
- url: facoltativo. Una URL risorsa per la risorsa utile o il piano di miglioramento. URLDeve iniziare con http:// ohttps://.

Nota

Quando sincronizzi il carico di lavoro di un obiettivo personalizzato con Jira, le scelte mostrano l' «id» della domanda e della scelta, oltre al «titolo» della scelta.

Il formato utilizzato è. [ QuestionID | ChoiceID ] ChoiceTitle


    "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_1.pdf"
             },
             "improvementPlan": {
                 "displayText": "This is text that will be shown for improvement of this choice.",
                 "url": "https://example.com/popt02_iplan_01.html"
             },
             "additionalResources":[
                {
                  "type": "HELPFUL_RESOURCE",
                  "content": [
                    {
                      "displayText": "This is the second set of helpful text for this choice.",
                      "url": "https://example.com/hr_manual_country.html"
                    },
                    {
                      "displayText": "This is the third set of helpful text for this choice.",
                      "url": "https://example.com/hr_manual_city.html"
                    }
                  ]
                },
                {
                  "type": "IMPROVEMENT_PLAN",
                  "content": [
                    {
                      "displayText": "This is additional text that will be shown for improvement of this choice.",
                      "url": "https://example.com/popt02_iplan_02.html"
                    },
                    {
                      "displayText": "This is the third piece of improvement plan text.",
                      "url": "https://example.com/popt02_iplan_03.html"
                    }
                    {
                      "displayText": "This is the fourth piece of improvement plan text.",
                      "url": "https://example.com/popt02_iplan_04.html"
                    }
                  ]
                }
              ]
         },
         {
              "id": "option_no",
              "title": "None of these",
              "helpfulResource": {
                "displayText": "Choose this if your workload does not follow these best practices.",
                "url": "https://example.com/popt02_iplan_none.html"
              }
              
            }

Sezione Regole di rischio

Questa sezione definisce in che modo le scelte selezionate determinano il livello di rischio.

È possibile definire un massimo di tre regole di rischio per domanda, una per ogni livello di rischio.

condition: Un'espressione booleana delle scelte che corrisponde a un livello di rischio per la domanda, oppure. default

Deve esserci una regola di default rischio per ogni domanda.
risk: Indica il rischio associato alla condizione. I valori validi sono HIGH_RISK, MEDIUM_RISK e NO_RISK.

L'ordine delle regole di rischio è significativo. La prima condition che valuta true stabilisce il rischio della domanda. Uno schema comune per l'implementazione delle regole di rischio consiste nell'iniziare con le regole meno rischiose (e in genere più granulari) per poi arrivare alle regole più rischiose (e meno specifiche).

Per esempio:


 "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"
       }
 ]

Se la domanda prevede tre scelte (choice_1, echoice_3)choice_2, queste regole di rischio determinano il comportamento seguente:

Se sono selezionate tutte e tre le scelte, non vi è alcun rischio.
Se una delle due choice_1 choice_2 opzioni è selezionata ed choice_3 è selezionata, il rischio è medio.
Se non choice_1 è selezionato ma choice_3 è selezionato, esiste anche un rischio medio.
Se nessuna di queste condizioni precedenti era vera, il rischio è elevato.

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Eliminazione di un obiettivo

Aggiornamenti dell'obiettivo