Composant CloudFormation exemple

Créez un rôle Gestion des identités et des accès AWS (IAM) qui délimite les ressources que les composants définis directement s'exécutant dans votre environnement peuvent mettre à disposition. AWS Proton assume ce rôle ultérieurement pour provisionner des composants directement définis dans l'environnement.

Pour cet exemple, utilisez la politique suivante :

Indiquez le rôle que vous avez créé à l'étape précédente lorsque vous créez ou mettez à jour l'environnement. Dans la AWS Proton console, spécifiez un rôle de composant sur la page Configurer l'environnement. Si vous utilisez l' AWS Proton API ou AWS CLI, spécifiez l'une CreateEnvironment ou l'componentRoleArnautre des actions de UpdateEnvironment l'API.

Créez un modèle de service qui fait référence à un composant directement défini attaché à l'instance de service.

L'exemple montre comment écrire un modèle de service robuste qui ne se casse pas si aucun composant n'est attaché à l'instance de service.

# service/instance_infrastructure/cloudformation.yaml

Resources: 
  TaskDefinition:
    Type: AWS::ECS::TaskDefinition
    Properties:
      TaskRoleArn: !Ref TaskRole
      ContainerDefinitions:
        - Name: '{{service_instance.name}}'
          # ...
          {% if service_instance.components.default.outputs | length > 0 %}
          Environment:
            {{ service_instance.components.default.outputs |
                proton_cfn_ecs_task_definition_formatted_env_vars }}
          {% endif %}

  # ...

  TaskRole:
    Type: AWS::IAM::Role
    Properties:
      # ...
      ManagedPolicyArns:
        - !Ref BaseTaskRoleManagedPolicy
        {{ service_instance.components.default.outputs
            | proton_cfn_iam_policy_arns }}

  # Basic permissions for the task
  BaseTaskRoleManagedPolicy:
    Type: AWS::IAM::ManagedPolicy
    Properties:
      # ...

Créez une nouvelle version mineure du modèle de service qui déclare les composants directement définis comme étant pris en charge.

Publiez la version mineure du nouveau modèle de service. Pour de plus amples informations, veuillez consulter Enregistrer et publier des modèles.

Veillez à autoriser les proton:CreateComponent développeurs qui utilisent ce modèle de service à jouer le rôle IAM.

Créez un service qui utilise la version du modèle de service créée par l'administrateur avec la prise en charge des composants. Vous pouvez également mettre à jour l'une de vos instances de service existantes pour utiliser la dernière version du modèle.

Écrivez un fichier modèle IaC de composant qui fournit un compartiment Amazon S3 et une politique d'accès associée et expose ces ressources sous forme de sorties.

# cloudformation.yaml

# A component that defines an S3 bucket and a policy for accessing the bucket.
Resources:
  S3Bucket:
    Type: AWS::S3::Bucket
    Properties:
      BucketName: '{{environment.name}}-{{service.name}}-{{service_instance.name}}-{{component.name}}'
  S3BucketAccessPolicy:
    Type: AWS::IAM::ManagedPolicy
    Properties:
      PolicyDocument:
        Version: "2012-10-17"
        Statement:
          - Effect: Allow
            Action:
              - 's3:Get*'
              - 's3:List*'
              - 's3:PutObject'
            Resource: !GetAtt S3Bucket.Arn
Outputs:
  BucketName:
    Description: "Bucket to access"
    Value: !GetAtt S3Bucket.Arn
  BucketAccessPolicyArn:
    Value: !Ref S3BucketAccessPolicy

Si vous utilisez l' AWS Proton API ou AWS CLIécrivez un fichier manifeste pour le composant.

infrastructure:
  templates:
    - file: "cloudformation.yaml"
      rendering_engine: jinja
      template_language: cloudformation

Créez un composant directement défini. AWS Proton assume le rôle de composant que l'administrateur a défini pour provisionner le composant.

Dans la AWS Proton console, sur la page Composants, choisissez Créer un composant. Pour les paramètres du composant, entrez un nom de composant et une description du composant (facultatif). Pour Attacher un composant, choisissez Attacher le composant à une instance de service. Sélectionnez votre environnement, votre service et votre instance de service. Pour Source du composant, choisissez CloudFormation, puis choisissez le fichier IaC du composant.

Si vous utilisez l' AWS Proton API ou AWS CLI utilisez l'action CreateComponent API. Définissez un composant name et optionneldescription. Réglez environmentNameserviceName, etserviceInstanceName. Définissez templateSource et manifest vers les chemins des fichiers que vous avez créés.

Mettez à jour votre instance de service pour la redéployer. AWS Proton utilise les sorties de votre composant dans le modèle d'instance de service rendu, pour permettre à votre application d'utiliser le compartiment Amazon S3 que le composant a provisionné.