元件 AWS CloudFormation 範例

以下是 AWS Proton 直接定義元件的完整範例，以及如何在 AWS Proton 服務中使用它。元件會佈建 Amazon Simple Storage Service (Amazon S3) 儲存貯體和相關的存取政策。服務執行個體可以參考此儲存貯體並使用它。儲存貯體名稱是以環境、服務、服務執行個體和元件的名稱為基礎，這表示儲存貯體會與延伸特定服務執行個體之元件範本的特定執行個體結合。開發人員可以根據此元件範本建立多個元件，為不同的服務執行個體和功能需求佈建 Amazon S3 儲存貯體。

此範例涵蓋撰寫各種必要的 AWS CloudFormation 基礎設施做為程式碼 (IaC) 檔案，以及建立必要的 AWS Identity and Access Management (IAM) 角色。此範例會依擁有人員角色的步驟分組。

管理員步驟

讓開發人員搭配服務使用元件

建立 AWS Identity and Access Management (IAM) 角色，以縮小直接定義在環境中執行元件的資源範圍。稍後會 AWS Proton 擔任此角色，以在環境中佈建直接定義的元件。

在此範例中，請使用下列政策：

範例直接定義的元件角色


{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "cloudformation:CancelUpdateStack",
        "cloudformation:CreateChangeSet",
        "cloudformation:DeleteChangeSet",
        "cloudformation:DescribeStacks",
        "cloudformation:ContinueUpdateRollback",
        "cloudformation:DetectStackResourceDrift",
        "cloudformation:DescribeStackResourceDrifts",
        "cloudformation:DescribeStackEvents",
        "cloudformation:CreateStack",
        "cloudformation:DeleteStack",
        "cloudformation:UpdateStack",
        "cloudformation:DescribeChangeSet",
        "cloudformation:ExecuteChangeSet",
        "cloudformation:ListChangeSets",
        "cloudformation:ListStackResources"
      ],
      "Resource": "arn:aws:cloudformation:*:123456789012:stack/AWSProton-*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "s3:CreateBucket",
        "s3:DeleteBucket",
        "s3:GetBucket",
        "iam:CreatePolicy",
        "iam:DeletePolicy",
        "iam:GetPolicy",
        "iam:ListPolicyVersions",
        "iam:DeletePolicyVersion"
      ],
      "Resource": "*",
      "Condition": {
        "ForAnyValue:StringEquals": {
          "aws:CalledVia": "cloudformation.amazonaws.com"
        }
      }
    }
  ]
}

當您建立或更新環境時，請提供您在上一個步驟中建立的角色。在 AWS Proton 主控台中，在設定環境頁面上指定元件角色。如果您使用的是 AWS Proton API 或 AWS CLI，請指定 CreateEnvironment 或 UpdateEnvironment API 動作componentRoleArn的。

建立服務範本，其參照連接至服務執行個體的直接定義元件。

此範例示範如何撰寫強大的服務範本，如果元件未連接到服務執行個體，則不會中斷。

範例使用元件的服務 CloudFormation IaC 檔案


# 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:
      # ...

建立新的服務範本次要版本，將直接定義的元件宣告為支援。
- Amazon S3 中的範本套件 – 在 AWS Proton 主控台中，當您建立服務範本版本時，針對支援的元件來源，選擇直接定義。如果您使用的是 AWS Proton API 或 AWS CLI，請在 CreateServiceTemplateVersion 或 UpdateServiceTemplateVersion API 動作的 supportedComponentSources 參數DIRECTLY_DEFINED中指定。
- 範本同步 – 對您的服務範本套件儲存庫遞交變更，您可以在主要版本目錄中supported_component_sources:的 .template-registration.yaml 檔案中將指定DIRECTLY_DEFINED為項目。如需有關此檔案的詳細資訊，請參閱同步服務範本。
發佈新的服務範本次要版本。如需詳細資訊，請參閱註冊和發佈範本。
請務必允許使用此服務範本之開發人員的 IAM 角色proton:CreateComponent中的。

開發人員步驟

搭配服務執行個體使用直接定義的元件

建立使用管理員使用元件支援建立之服務範本版本的服務。或者，更新其中一個現有的服務執行個體，以使用最新的範本版本。

撰寫元件 IaC 範本檔案，以佈建 Amazon S3 儲存貯體和相關的存取政策，並將這些資源公開為輸出。

範例元件 CloudFormation IaC 檔案


# 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

如果您使用 AWS Proton API 或 AWS CLI，請撰寫元件的資訊清單檔案。

範例直接定義的元件資訊清單


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

建立直接定義的 component. AWS Proton assume 元件角色，由管理員定義來佈建元件。

在 AWS Proton 主控台的元件頁面上，選擇建立元件。在元件設定中，輸入元件名稱和選用的元件描述。針對元件連接，選擇將元件連接至服務執行個體。選取您的環境、服務和服務執行個體。針對元件來源，選擇 AWS CloudFormation，然後選擇元件 IaC 檔案。

注意
您不需要提供資訊清單，主控台會為您建立資訊清單。

如果您使用 AWS Proton API 或 AWS CLI，請使用 CreateComponent API 動作。設定元件name和選用的 description。設定 environmentName、 serviceName和 serviceInstanceName。manifest 將 templateSource和設定為您所建立檔案的路徑。

注意
當您指定服務和服務執行個體名稱時，可選擇性指定環境名稱。這兩者的組合在 AWS 您的帳戶中是唯一的，並且 AWS Proton 可以從服務執行個體判斷環境。
更新您的服務執行個體以重新部署它。 AWS Proton 會使用轉譯服務執行個體範本中元件的輸出，讓您的應用程式能夠使用元件佈建的 Amazon S3 儲存貯體。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

元件 IaC 檔案

儲存庫

元件 AWS CloudFormation 範例

管理員步驟

讓開發人員搭配 服務使用元件

範例 直接定義的元件角色

範例 使用元件的服務 CloudFormation IaC 檔案