View a markdown version of this page

La section des ressources du fichier manifeste cFCT - AWS Control Tower

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

La section des ressources du fichier manifeste cFCT

Cette rubrique décrit la section des ressources du fichier manifeste cFCT, dans laquelle vous allez définir les ressources requises pour vos personnalisations. Cette section du fichier manifeste cFCT commence au niveau des ressources du mot clé et se poursuit jusqu'à la fin du fichier.

La section des ressources du fichier manifeste spécifie les CloudFormation StackSets AWS Organizations SCP et les RCP que cFCT déploie automatiquement via le pipeline de code. Vous pouvez répertorier les unités d'organisation, les comptes et les régions pour déployer des instances de stack.

Les instances Stack sont déployées au niveau du compte plutôt qu'au niveau de l'unité d'organisation. Les SCP et les RCP sont déployés au niveau de l'UO. Pour plus d'informations, voir Créer vos propres personnalisations.

L'exemple de modèle suivant décrit les entrées possibles disponibles pour la section des ressources du fichier manifeste. 

resources: # List of resources
  - name: [String]
    resource_file: [String] [Local File Path, S3 URI, S3 URL] 
    deployment_targets: # account and/or organizational unit names
      accounts: # array of strings, [0-9]{12}
        - 012345678912
        - AccountName1
      organizational_units: #array of strings
        - OuName1
        - OuName2 
    deploy_method: scp | stack_set | rcp
    parameters: # List of parameters [SSM, Alfred, Values]
      - parameter_key: [String]
        parameter_value: [String]  
    export_outputs: # list of ssm parameters to store output values
      - name: /org/member/test-ssm/app-id
        value: $[output_ApplicationId]    
    regions: #list of strings
    - [String]

La suite de cette rubrique fournit des définitions détaillées pour les mots-clés présentés dans l'exemple de code précédent.

name  : nom associé au CloudFormation StackSets.
La chaîne que vous fournissez attribue un nom plus convivial à un ensemble de piles.

  • Type : chaîne

  • Obligatoire : oui

  • Valeurs valides : a-z A-Z, 0-9 et un tiret (-). Le nom doit commencer par un caractère alphabétique.

description  : description de la ressource.

  • Type : chaîne

  • Obligatoire : non

resource_file — Ce fichier peut être spécifié comme emplacement relatif au fichier manifeste, à un URI Amazon S3 ou à une URL qui pointe vers un CloudFormation modèle ou une politique de contrôle des AWS Organizations services en JSON pour créer des CloudFormation ressources, des SCP ou des RCP.

  • Type : chaîne

  • Obligatoire : oui

  1. L'exemple suivant montre resource_file l'emplacement relatif donné au fichier de ressources dans le package de configuration.

    resources:
  - name: SecurityRoles
    resource_file: templates/custom-security.template

  2. L'exemple suivant montre le fichier de ressources fourni sous forme d'URI Amazon S3. 

    resources:
  - name: SecurityRoles
    resource_file: s3://amzn-s3-demo-bucket/[key-name]

  3. L'exemple suivant montre le fichier de ressources fourni sous la forme d'une URL HTTPS Amazon S3. 

    resources:
  - name: SecurityRoles
    resource_file: https://bucket-name.s3.Region.amazonaws.com/key-name
    Note

    Si vous fournissez une URL Amazon S3, vérifiez que la politique de compartiment autorise l'accès en lecture au compte de gestion AWS Control Tower à partir duquel vous déployez cFCT. Si vous fournissez une URL HTTPS Amazon S3, vérifiez que le chemin utilise la notation par points. Par exemple, S3.us-west-1. La CfCT ne prend pas en charge les points de terminaison qui contiennent un tiret entre S3 et la région, tels que. S3‐us-west-2

  4. L'exemple suivant montre une politique de compartiment Amazon S3 et un ARN dans lequel les ressources sont stockées.

    {
   "Version": "2012-10-17",
   "Statement": [
       {
        "Effect": "Allow",
        "Principal": {"AWS": "arn:aws:iam::AccountId:root"},
        "Action": "s3:GetObject",
        "Resource": "arn:aws:s3:::my-bucket/*”
       }
   ]
}



    Vous allez remplacer la AccountId variable présentée dans l'exemple par l'ID de AWS compte du compte de gestion qui déploie cFCT. Pour plus d'exemples, consultez la section Exemples de politiques relatives aux compartiments dans le guide de l'utilisateur d'Amazon Simple Storage Service.

paramètres — Spécifie le nom et la valeur des CloudFormation paramètres.

  • Type MapList :

  • Obligatoire : non

La section des paramètres contient des paires de key/value paramètres. Le pseudo-modèle suivant décrit la section des paramètres.

parameters:
  - parameter_key: [String]
    parameter_value: [String]

  • parameter_key — La clé associée au paramètre.

    • Type : chaîne

    • Obligatoire : Oui (dans la propriété des paramètres)

    • Valeurs valides : a-z et A-Z 0-9

  • parameter_value — La valeur d'entrée associée au paramètre.

    • Type : chaîne

    • Obligatoire : Oui (dans la propriété des paramètres)

deploy_method — Méthode de déploiement pour déployer des ressources sur le compte. Actuellement, deploy_method prend en charge le déploiement de ressources à l'aide de l'stack_setoption de déploiement des ressources via CloudFormation StackSets, l'scpoption si vous déployez des SCP, ou l'rcpoption si vous déployez des RCP.

  • Type : chaîne

  • Valeurs Valides : stack_set | scp | rcp

  • Obligatoire : oui

deployment_targets — Liste des comptes ou des unités organisationnelles (OU) dans lesquels cFCT déploiera les CloudFormation ressources, spécifiées sous la forme accounts ou organizational_units.

Note

Si vous souhaitez déployer un SCP ou un RCP, la cible doit être une unité d'organisation et non un compte.

  • Tapez : liste de chaînes account name ou account number pour indiquer que cette ressource sera déployée dans la liste de comptes donnée, ou OU names pour indiquer que cette ressource sera déployée dans la liste d'unités organisationnelles donnée.

  • Obligatoire : au moins un des comptes ou unités_organisationnels

    • comptes :

      Tapez : Liste de chaînes account name ou account number pour indiquer que cette ressource sera déployée dans la liste de comptes donnée.

    • unités_organisationnelles :

      Type : liste de chaînes OU names indiquant que cette ressource sera déployée dans une liste d'unités organisationnelles donnée. Si vous fournissez une unité d'organisation qui ne contient pas de comptes et que la propriété accounts n'est pas ajoutée, cFCT crée uniquement le stack set.

      Note

      L'ID du compte de gestion de l'organisation n'est pas une valeur autorisée. Par défaut, cFCT ne prend pas en charge le déploiement d'instances de pile sur le compte de gestion de l'organisation. Si vous avez un cas d'utilisation particulier, consultez Root OU.

export_outputs — Liste des name/value paires qui indiquent les clés de paramètres SSM. Ces clés de paramètres SSM vous permettent de stocker les sorties du modèle dans le magasin de paramètres SSM. La sortie est destinée à être référencée par d'autres ressources, définies précédemment dans le fichier manifeste.

export_outputs: # List of SSM parameters
  - name: [String]
    value: [String]

  • Type : liste de paires de clés nom/valeur. Le nom contient la name chaîne d'une clé de stockage de paramètres SSM et la valeur contient la value chaîne du paramètre.

  • Valeurs valides : n'importe quelle chaîne ou $[output_CfnOutput-Logical-ID] variable CfnOutput-Logical-ID correspondant à la variable de sortie du modèle. Pour plus d'informations sur la section Sorties d'un CloudFormation modèle, voir Sorties dans le Guide de CloudFormation l'utilisateur.

  • Obligatoire : non

Par exemple, l'extrait de code suivant stocke la variable de VPCID sortie du modèle dans la clé de paramètre SSM nommée. /org/member/audit/vpc_id

export_outputs: # List of SSM parameters
  - name: /org/member/audit/VPC-ID
    value: $[output_VPCID]
Note

Le nom de clé export_outputs peut contenir une valeur autre que. output Par exemple, si le nom est/org/environment-name, la valeur peut êtreproduction.

regions  : liste des régions dans lesquelles cFCT déploiera les instances de CloudFormation stack.

  • Type : n'importe quelle liste de noms de régions AWS commerciales, pour indiquer que cette ressource sera déployée dans la liste de régions donnée. Si ce mot clé n'existe pas dans le fichier manifeste, les ressources sont déployées uniquement dans la région d'origine.

  • Obligatoire : non