翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CloudFormation テンプレートを製品に追加する

AWS Marketplace 販売者は、 AWS CloudFormation テンプレートを使用して AWS Marketplace 購入者に配信される AMI ベースの製品を一覧表示できます。AMI ベースの製品に CloudFormation テンプレートを追加すると、購入者はリソースと依存関係を手動で設定しなくてもソリューションをデプロイできます。テンプレートを使用して、各製品の分散アーキテクチャまたはクラスターを定義する、または異なる AMI の組み合わせや製品設定を選択できます。単一の AMI ソリューションには、最大 3 つの CloudFormation テンプレートを含めることができます。

CloudFormation テンプレートは、単一の Amazon マシンイメージ (AMI) を、関連する構成ファイルと Lambda 関数と共に配信するように設定できます。さらに、各テンプレートのアーキテクチャ図を含める必要があります。

CloudFormation テンプレートの準備

CloudFormation テンプレートを構築するには、テンプレートの前提条件を満たし、必要な入力とセキュリティパラメータを用意する必要があります。CloudFormation テンプレートを送信する場合は、以下のセクションのガイドラインに従ってください。

テンプレートの前提条件

AMI の詳細の要件

AWS::EC2::Instance、AWS::AWS::AutoScaling::LaunchConfigurationAWS::EC2::LaunchTemplate リソースなどの EC2 インスタンスに AMI をデプロイするリソースの ImageIdプロパティを指定する場合は、テンプレートパラメータを参照する必要があります。 AWS::EC2::Instance パラメータタイプは、AWS::EC2::Image::Id、AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>、または のいずれかである必要がありますString。

このテンプレートパラメータには、任意の有効なパラメータ名を指定できます。 は、テンプレートを独自の Amazon S3 バケット AWS Marketplace にコピーし、指定されたパラメータを AWS Systems Manager Parameter Store パラメータに置き換えます。購入者がテンプレートをデプロイすると、そのパラメータは公開済み製品の AWS リージョン特定の AMI ID に解決されます。

次のテンプレート例は、組み込み関数 Ref を使用してテンプレートパラメータを参照する ImageIdプロパティを示しています。

YAML の例：

Parameters:
  ImageId:
    Type: AWS::EC2::Image::Id
    Default: ami-example1234567890
Resources:
  MyInstance:
    Type: AWS::EC2::Instance
    Properties:
      ImageId: !Ref ImageId

JSON の例：

{
  "Parameters": {
    "ImageId": {
      "Type": "AWS::EC2::Image::Id",
      "Default": "ami-example1234567890"
    }
  },
  "Resources": {
    "MyInstance": {
      "Type": "AWS::EC2::Instance",
      "Properties": {
        "ImageId": {
          "Ref": "ImageId"
        }
      }
    }
  }
}

ルートスタックではなくネストされたスタック内に EC2 インスタンスをデプロイする場合、AMI ID はルートスタックからその値を動的に継承する必要があります。ルートスタックとネストされたスタックを編集して、ルートスタックでテンプレートパラメータの値を設定すると、このネストされたスタックで使用される AMI ID が上書きされるようにします。

製品ロードフォームを使用した AMI の詳細の要件

AMI は各リージョンのマッピングテーブルに存在する必要があります。 AWS Marketplace チームは、AMI IDs がクローンされた後に更新します。ソース AMI は us-east-1リージョンにある必要があります。他のリージョンではプレースホルダーを使用できます。

YAML の例：

Mappings: 
  RegionMap: 
      us-east-1: 
          ImageId: ami-0123456789abcdef0
      us-west-1: 
          ImageId: ami-xxxxxxxxxxxxxxxxx
      eu-west-1: 
          ImageId: ami-xxxxxxxxxxxxxxxxx
      ap-southeast-1: 
          ImageId: ami-xxxxxxxxxxxxxxxxx
Resources:
  EC2Instance:
    Type: AWS::EC2::Instance
    Properties:
      ImageId: !FindInMap 
        - RegionMap
        - !Ref AWS::Region
        - ImageId

ネストされたスタックテンプレートの要件

テンプレートにネストされたスタックが含まれている場合、ネストされたスタックリソースの TemplateURLプロパティは、Amazon S3 バケット名、バケットリージョン、および Amazon S3 オブジェクトキープレフィックスのテンプレートパラメータを参照する必要があります。バケット名のパラメータ名は MPS3BucketName、バケットリージョンは MPS3BucketRegion、オブジェクトキープレフィックスの は である必要がありますMPS3KeyPrefix。

ネストされたテンプレートが保存されている Amazon S3 バケットに対応するように、これらのパラメータのデフォルト値を設定します。ネストされたテンプレートはすべてパブリックにアクセス可能である必要があります。公開用にテンプレートを送信すると、 はテンプレートを独自の Amazon S3 バケット AWS Marketplace にコピーし、コピーの保存先に対応するようにこれら 3 つのパラメータのデフォルト値を変更します。

複数のレベルのネストされたスタックがある場合、追加のネストされたスタックを作成するすべてのネストされたスタックは、TemplateURLプロパティがルートスタックから S3 バケット名、S3 バケットリージョン、および S3 オブジェクトキーの値を動的に継承するように設定する必要があります。ルートスタックとネストされたスタックを編集して、ルートスタックでテンプレートパラメータ MPS3BucketName、、 の値を設定すると、このネストされたスタックで使用される URL 内のそれぞれの値がMPS3KeyPrefix上書きされMPS3BucketRegion、追加のネストされたスタックが作成されます。

次のテンプレート例は、組み込み関数 Fn::Sub を使用してテンプレートパラメータを参照する TemplateURLプロパティを示しています。

YAML の例：

AWSTemplateFormatVersion: '2010-09-09'
Metadata:
  AWS::CloudFormation::Interface:
    ParameterGroups:
      - Label:
          default: AWS Marketplace Parameters
        Parameters:
          - ImageId
          - MPS3BucketName
          - MPS3BucketRegion
          - MPS3KeyPrefix
Parameters:
  ImageId:
    Type: AWS::EC2::Image::Id
    Default: ami-example1234567890
    Description: The AMI that will be used to launch EC2 resources.
  MPS3BucketName:
    Type: String
    Default: sellerbucket
    Description: Name of the S3 bucket for your copy of the nested templates.
  MPS3BucketRegion:
    Type: String
    Default: us-east-1
    Description: AWS Region where the S3 bucket for your copy of the nested templates is hosted.
  MPS3KeyPrefix:
    Type: String
    Default: sellerproductfolder/
    Description: S3 key prefix that is used to simulate a folder for your copy of the nested templates.
Resources:
  EC2Instance:
    Type: AWS::EC2::Instance
    Properties:
      ImageId: !Ref ImageId
  NestedStack:
    Type: AWS::CloudFormation::Stack
    Properties:
      TemplateURL: !Sub https://${MPS3BucketName}.s3.${MPS3BucketRegion}.${AWS::URLSuffix}/${MPS3KeyPrefix}nested-template.yaml

JSON の例：

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Metadata": {
        "AWS::CloudFormation::Interface": {
            "ParameterGroups": [
                {
                    "Label": {
                        "default": "AWS Marketplace Parameters"
                    },
                    "Parameters": [
                        "ImageId",
                        "MPS3BucketName",
                        "MPS3BucketRegion",
                        "MPS3KeyPrefix"
                    ]
                }
            ]
        }
    },
    "Parameters": {
        "ImageId": {
            "Type": "AWS::EC2::Image::Id",
            "Default": "ami-example1234567890",
            "Description": "The AMI that will be used to launch EC2 resources."
        },
        "MPS3BucketName": {
            "Type": "String",
            "Default": "sellerbucket",
            "Description": "Name of the S3 bucket for your copy of the nested templates."
        },
        "MPS3BucketRegion": {
            "Type": "String",
            "Default": "us-east-1",
            "Description": "AWS Region where the S3 bucket for your copy of the nested templates is hosted."
        },
        "MPS3KeyPrefix": {
            "Type": "String",
            "Default": "sellerproductfolder/",
            "Description": "S3 key prefix that is used to simulate a folder for your copy of the nested templates."
        }
    },
    "Resources": {
        "EC2Instance": {
            "Type": "AWS::EC2::Instance",
            "Properties": {
                "ImageId": {
                    "Ref": "ImageId"
                }
            }
        },
        "NestedStack": {
            "Type": "AWS::CloudFormation::Stack",
            "Properties": {
                "TemplateURL": {
                    "Fn::Sub": "https://${MPS3BucketName}.s3.${MPS3BucketRegion}.${AWS::URLSuffix}/${MPS3KeyPrefix}nested-template.yaml"
                }
            }
        }
    }
}

テンプレート入力パラメータ

ネットワークおよびセキュリティパラメータ

テンプレートを受け取ると、 は製品設定と情報 AWS Marketplace を検証し、必要なリビジョンに関するフィードバックを提供します。

アーキテクチャ図

各テンプレートのアーキテクチャ図を用意する必要があります。ダイアグラムの詳細については、「アーキテクチャダイアグラムとは」を参照してください。

図は次の基準を満たしている必要があります。

既存の製品の CloudFormation テンプレートを変換する

セルフサービスエクスペリエンスを使用して、以前に製品ロードフォームを使用して公開した既存の製品を更新する場合は、既存の CloudFormation テンプレートを変更する必要があります。

次の表は、製品ロードフォームとセルフサービスエクスペリエンスの使用の違いを示しています。

次のサンプルテンプレートは、製品ロードフォームを使用してテンプレートを公開した既存の製品の例を示しています。この例では、AMI ID は ami-example123456で、ネストされたテンプレートは販売者の S3 バケットの の場所にありますhttps://sellerbucket.s3.us-east-1.amazonaws.com/sellerproductfolder/nested-template.yaml。

製品ロードフォームで公開された YAML の例：

AWSTemplateFormatVersion: '2010-09-09'
Mappings:
  RegionMap:
    us-east-1:
      AMI: ami-example123456
Resources:
  EC2Instance:
    Type: AWS::EC2::Instance
    Properties:
      ImageId: !FindInMap 
        - RegionMap
        - !Ref AWS::Region
        - AMI
  NestedStack:
    Type: AWS::CloudFormation::Stack
    Properties:
      TemplateURL: https://sellerbucket.s3.us-east-1.amazonaws.com/sellerproductfolder/nested-template.yaml

製品ロードフォームで公開された JSON の例：

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Mappings": {
        "RegionMap": {
            "us-east-1": {
                "AMI": "ami-example123456"
            }
        }
    },
    "Resources": {
        "EC2Instance": {
            "Type": "AWS::EC2::Instance",
            "Properties": {
                "ImageId": {
                    "Fn::FindInMap": [
                        "RegionMap",
                        {
                            "Ref": "AWS::Region"
                        },
                        "AMI"
                    ]
                }
            }
        },
        "NestedStack": {
            "Type": "AWS::CloudFormation::Stack",
            "Properties": {
                "TemplateURL": "https://sellerbucket.s3.us-east-1.amazonaws.com/sellerproductfolder/nested-template.yaml"
            }
        }
    }
}

次のテンプレート例は、セルフサービスエクスペリエンスを使用して製品を更新するために必要な変更を示しています。

セルフサービスエクスペリエンスで公開された YAML の例：

AWSTemplateFormatVersion: '2010-09-09'
Metadata:
  AWS::CloudFormation::Interface:
    ParameterGroups:
      - Label:
          default: AWS Marketplace Parameters
        Parameters:
          - ImageId
          - MPS3BucketName
          - MPS3BucketRegion
          - MPS3KeyPrefix
Parameters:
  ImageId:
    Type: AWS::EC2::Image::Id
    Default: ami-example123456
    Description: The AMI that will be used to launch EC2 resources.
  MPS3BucketName:
    Type: String
    Default: sellerbucket
    Description: Name of the S3 bucket for your copy of the nested templates.
  MPS3BucketRegion:
    Type: String
    Default: us-east-1
    Description: AWS Region where the S3 bucket for your copy of the nested templates is hosted.
  MPS3KeyPrefix:
    Type: String
    Default: sellerproductfolder/
    Description: S3 key prefix that is used to simulate a folder for your copy of the nested templates.
Resources:
  EC2Instance:
    Type: AWS::EC2::Instance
    Properties:
      ImageId: !Ref ImageId
  NestedStack:
    Type: AWS::CloudFormation::Stack
    Properties:
      TemplateURL: !Sub https://${MPS3BucketName}.s3.${MPS3BucketRegion}.${AWS::URLSuffix}/${MPS3KeyPrefix}nested-template.yaml

セルフサービスエクスペリエンスで公開された JSON の例：

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Metadata": {
        "AWS::CloudFormation::Interface": {
            "ParameterGroups": [
                {
                    "Label": {
                        "default": "AWS Marketplace Parameters"
                    },
                    "Parameters": [
                        "ImageId",
                        "MPS3BucketName",
                        "MPS3BucketRegion",
                        "MPS3KeyPrefix"
                    ]
                }
            ]
        }
    },
    "Parameters": {
        "ImageId": {
            "Type": "AWS::EC2::Image::Id",
            "Default": "ami-example123456",
            "Description": "The AMI that will be used to launch EC2 resources."
        },
        "MPS3BucketName": {
            "Type": "String",
            "Default": "sellerbucket",
            "Description": "Name of the S3 bucket for your copy of the nested templates."
        },
        "MPS3BucketRegion": {
            "Type": "String",
            "Default": "us-east-1",
            "Description": "AWS Region where the S3 bucket for your copy of the nested templates is hosted."
        },
        "MPS3KeyPrefix": {
            "Type": "String",
            "Default": "sellerproductfolder/",
            "Description": "S3 key prefix that is used to simulate a folder for your copy of the nested templates."
        }
    },
    "Resources": {
        "EC2Instance": {
            "Type": "AWS::EC2::Instance",
            "Properties": {
                "ImageId": {
                    "Ref": "ImageId"
                }
            }
        },
        "NestedStack": {
            "Type": "AWS::CloudFormation::Stack",
            "Properties": {
                "TemplateURL": {
                    "Fn::Sub": "https://${MPS3BucketName}.s3.${MPS3BucketRegion}.${AWS::URLSuffix}/${MPS3KeyPrefix}nested-template.yaml"
                }
            }
        }
    }
}