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.

Ajoutez CloudFormation des modèles à votre produit

AWS Marketplace les vendeurs peuvent répertorier les AMI-based produits livrés aux AWS Marketplace acheteurs à l'aide AWS CloudFormation de modèles. L'ajout d'un CloudFormation modèle à votre AMI-based produit permet à vos acheteurs de déployer votre solution sans avoir à configurer manuellement les ressources et les dépendances. Vous pouvez utiliser les modèles afin de définir un cluster ou une architecture distribuée pour les produits ou de sélectionner différentes combinaisons d'AMI ou configurations de produits. Les solutions AMI uniques peuvent contenir au maximum trois CloudFormation modèles.

Les CloudFormation modèles peuvent être configurés pour fournir une seule Amazon Machine Image (AMI) avec les fichiers de configuration et les fonctions Lambda associés. En outre, vous devez inclure un schéma architectural pour chaque modèle.

Préparation de votre CloudFormation modèle

Pour créer vos CloudFormation modèles, vous devez remplir les conditions requises et fournir les paramètres d'entrée et de sécurité requis. Lorsque vous soumettez votre CloudFormation modèle, suivez les instructions des sections suivantes.

Conditions préalables relatives au modèle

Exigences relatives aux informations relatives à l'AMI

Lorsque vous spécifiez la ImageId propriété des ressources qui déploient votre AMI sur des instances EC2 telles que AWS : :EC2 : :Instance, : : et AWS AWS::AutoScaling : :EC2 : : LaunchTemplate resources LaunchConfiguration, vous devez faire référence à un paramètre de modèle. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html Le type de paramètre doit être a AWS::EC2::Image::IdAWS::SSM::Parameter::Value<AWS::EC2::Image::Id>, ouString.

Vous pouvez donner à ce paramètre de modèle un nom de paramètre valide. AWS Marketplace copie votre modèle dans ses propres compartiments Amazon S3 et remplace le paramètre spécifié par un AWS Systems Manager paramètre Parameter Store. AWS Marketplace met également à jour la description et le texte des contraintes afin que la valeur correcte soit clairement indiquée aux acheteurs qui déploient le modèle. Lorsque les acheteurs déploient votre modèle, ce paramètre est résolu en fonction de l'ID AMI Région AWS spécifique à votre produit publié.

Les exemples de modèles suivants illustrent la ImageId propriété référençant les paramètres du modèle à l'aide de la fonction intrinsèque Ref.

Exemple YAML :

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

Exemple JSON :

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

Si vous déployez des instances EC2 dans une pile imbriquée au lieu de la pile racine, l'ID AMI doit hériter dynamiquement de sa valeur de la pile racine. Modifiez votre pile racine et vos piles imbriquées de telle sorte que, dans la pile racine, la définition de la valeur de votre paramètre de modèle remplace l'ID AMI utilisé dans cette pile imbriquée.

Exigences relatives aux informations relatives à l'AMI à l'aide du formulaire de chargement du produit

Les AMI doivent figurer dans une table de mappage pour chaque région. L' AWS Marketplace équipe met à jour les ID AMI après leur clonage. Votre AMI source doit se trouver dans la us-east-1 région. Les autres régions peuvent utiliser des espaces réservés.

Exemple 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

Exigences relatives aux modèles de pile imbriqués

Si votre modèle inclut des piles imbriquées, la TemplateURL propriété des ressources des piles imbriquées doit faire référence aux paramètres du modèle pour le nom du compartiment Amazon S3, la région du compartiment et le préfixe de la clé d'objet Amazon S3. Les noms des paramètres pour le nom du compartiment doivent êtreMPS3BucketName, la région du compartiment doit êtreMPS3BucketRegion, et pour l'objet, le préfixe de clé doit êtreMPS3KeyPrefix.

Définissez les valeurs par défaut pour ces paramètres afin qu'elles correspondent à votre compartiment Amazon S3 dans lequel vos modèles imbriqués sont stockés. Tous les modèles imbriqués doivent être accessibles au public. Lorsque vous soumettez votre modèle pour publication, vous AWS Marketplace copiez vos modèles dans ses propres compartiments Amazon S3 et modifiez les propriétés de ces trois paramètres pour que la valeur par défaut et la valeur autorisée soient définies de manière à correspondre à l'endroit où les copies sont stockées. AWS Marketplace met également à jour la description et le texte des contraintes pour indiquer clairement les valeurs correctes aux acheteurs qui déploient le modèle.

Si vous avez plusieurs niveaux de piles imbriquées, toutes les piles imbriquées qui créent des piles imbriquées supplémentaires doivent être configurées de manière à ce que la TemplateURL propriété hérite dynamiquement des valeurs du nom du compartiment Amazon S3, de la région du compartiment Amazon S3 et de la clé d'objet Amazon S3 de la pile racine. Modifiez vos piles racine et imbriquées de manière à les placer dans la pile racine, en définissant la valeur du paramètre du modèle MPS3BucketNameMPS3BucketRegion, et MPS3KeyPrefix remplacez leurs valeurs respectives dans l'URL utilisée dans cette pile imbriquée pour créer des piles imbriquées supplémentaires.

Les exemples de modèles suivants illustrent la TemplateURL propriété référençant les paramètres du modèle à l'aide de la fonction intrinsèque Fn : :Sub.

Exemple 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

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

Paramètres d'entrée du modèle

Paramètres réseau et de sécurité

Une fois votre modèle reçu, il AWS Marketplace valide la configuration et les informations du produit et fournit des commentaires pour toute révision requise.

Schéma architectural

Vous devez fournir un schéma architectural pour chaque modèle. Pour en savoir plus sur la création de diagrammes, voir Qu'est-ce que la création de diagrammes d'architecture ?

Le schéma doit répondre aux critères suivants :

Convertir CloudFormation les modèles de produits existants

Si vous souhaitez utiliser l'expérience en libre-service pour mettre à jour un produit existant qui utilisait auparavant le formulaire de chargement du produit pour publier, vous devez apporter des modifications à votre CloudFormation modèle existant.

Le tableau suivant décrit la différence entre l'utilisation du formulaire de chargement du produit et l'expérience en libre-service :

Les exemples de modèles suivants illustrent un exemple de produit existant qui a utilisé le formulaire de chargement du produit pour publier le modèle. Dans cet exemple, l'ID AMI se trouve ami-example123456 et un modèle imbriqué se trouve dans le compartiment S3 du vendeur sur placehttps://sellerbucket.s3.us-east-1.amazonaws.com/sellerproductfolder/nested-template.yaml.

Exemple YAML publié avec le formulaire de chargement du produit :

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

Exemple JSON publié avec le formulaire de chargement du produit :

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

Les exemples de modèles suivants illustrent les modifications requises pour utiliser l'expérience en libre-service afin de mettre à jour le produit.

Exemple YAML publié avec l'expérience en libre-service :

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

Exemple JSON publié avec l'expérience en libre-service :

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