Types de paramètres Utilisation de paramètres

AWS Proton paramètres

Vous pouvez définir et utiliser les paramètres de votre infrastructure sous forme de fichiers de code (IaC) pour les rendre flexibles et réutilisables. Vous pouvez lire la valeur d'un paramètre dans vos fichiers IaC en vous référant au nom du paramètre dans l'espace de noms des AWS Proton paramètres. AWS Proton injecte des valeurs de paramètres dans les fichiers iAc rendus qu'il génère lors du provisionnement des ressources. Pour traiter les AWS CloudFormation paramètres IaC, AWS Proton utilise Jinja. Pour traiter les paramètres Terraform IaC, AWS Proton génère un fichier de valeurs de paramètres Terraform et s'appuie sur la capacité de paramétrage intégrée à HCL.

AvecCodeBuildapprovisionnement, AWS Proton génère un fichier d'entrée que votre code peut importer. Le fichier est un fichier JSON ou HCL, selon une propriété du manifeste de votre modèle. Pour de plus amples informations, veuillez consulter CodeBuild détails et exemples des paramètres de provisionnement.

Vous pouvez faire référence aux paramètres de votre environnement, de vos services et de vos composants, aux fichiers iAc ou au code de provisionnement en respectant les exigences suivantes :

La longueur de chaque nom de paramètre ne dépasse pas 100 caractères.
La longueur de l'espace de noms des paramètres et du nom de ressource combinés ne dépasse pas la limite de caractères du nom de la ressource.

AWS Proton le provisionnement échoue si ces quotas sont dépassés.

Types de paramètres

Les types de paramètres suivants sont à votre disposition à titre de référence dans les fichiers AWS Proton IaC :

Paramètre d'entrée

Les environnements et les instances de service peuvent prendre des paramètres d'entrée que vous définissez dans un fichier de schéma que vous associez à l'environnement ou au modèle de service. Vous pouvez vous référer aux paramètres d'entrée d'une ressource dans le fichier IaC de la ressource. Les fichiers iAc du composant peuvent faire référence aux paramètres d'entrée de l'instance de service à laquelle le composant est attaché.

AWS Proton vérifie les noms des paramètres d'entrée par rapport à votre fichier de schéma et les associe aux paramètres référencés dans vos fichiers iAc pour injecter les valeurs d'entrée que vous fournissez dans un fichier de spécifications lors du provisionnement des ressources.

Paramètre de sortie

Vous pouvez définir des sorties dans n'importe lequel de vos fichiers iAc. Une sortie peut être, par exemple, le nom, l'ID ou l'ARN de l'une des ressources fournies par le modèle, ou elle peut être un moyen de passer par l'une des entrées du modèle. Vous pouvez faire référence à ces sorties dans les fichiers IaC d'autres ressources.

Dans les CloudFormation fichiers IaC, définissez les paramètres de sortie dans le Outputs: bloc. Dans un fichier Terraform iAC, définissez chaque paramètre de sortie à l'aide d'une output instruction.

Paramètre de ressource

AWS Proton crée automatiquement les paramètres AWS Proton des ressources. Ces paramètres exposent les propriétés de l'objet de AWS Proton ressource. Voici un exemple de paramètre de ressourceenvironment.name.

Utilisation de AWS Proton paramètres dans vos fichiers iAc

Pour lire la valeur d'un paramètre dans un fichier IaC, vous devez vous référer au nom du paramètre dans l'espace de noms des AWS Proton paramètres. Pour les fichiers AWS CloudFormation iAC, vous devez utiliser la syntaxe Jinja et entourer le paramètre de paires d'accolades et de guillemets.

Le tableau suivant indique la syntaxe de référence pour chaque langage de modèle pris en charge, avec un exemple.

Langage du modèle Syntaxe Exemple : entrée d'environnement nommée « VPC »

Langage du modèle	Syntaxe	Exemple : entrée d'environnement nommée « VPC »
CloudFormation	`"{{ parameter-name }}"`	`"{{ environment.inputs.VPC }}"`
Terraform	`var.parameter-name`	`var.environment.inputs.VPC` Définitions de variables Terraform générées

CloudFormation

"{{ parameter-name }}"

"{{ environment.inputs.VPC }}"

Terraform

var.parameter-name

var.environment.inputs.VPC

Définitions de variables Terraform générées

Note

Si vous utilisez des paramètres CloudFormation dynamiques dans votre fichier IaC, vous devez y échapper pour éviter les erreurs d'interprétation par Jinja. Pour plus d’informations, consultez Résolution des problèmes de AWS Proton.

Le tableau suivant répertorie les noms d'espaces de noms pour tous les paramètres de AWS Proton ressources. Chaque type de fichier modèle peut utiliser un sous-ensemble différent de l'espace de noms des paramètres.

Fichier modèle	Type de paramètre	Nom du paramètre	Description
Environnement	ressource	`environment.name`	Nom de l'environnement
Environnement	input	`environment.inputs.input-name`	Entrées d'environnement définies par le schéma
Service	ressource	`environment.name` `environment.account_id`	Nom et Compte AWS ID de l'environnement
	output	`environment.outputs.output-name`	Sorties de fichiers iAC de l'environnement
	ressource	`service.branch_name` `service.name` `service.repository_connection_arn` `service.repository_id`	Nom du service et référentiel de code
	ressource	`service_instance.name`	Nom de l'instance de service
	input	`service_instance.inputs.input-name`	Entrées d'instance de service définies par le schéma
	ressource	`service_instance.components.default.name`	Nom du composant par défaut joint
	output	`service_instance.components.default.outputs.output-name`	Sorties du fichier iAC du composant par défaut joint
Pipeline	ressource	`service_instance.environment.name` `service_instance.environment.account_id`	Nom et Compte AWS ID de l'environnement de l'instance de service
	output	`service_instance.environment.outputs.output-name`	Sorties de fichiers iAC de l'environnement d'instance de service
	input	`pipeline.inputs.input-name`	Entrées de pipeline définies par le schéma
	ressource	`service.branch_name` `service.name` `service.repository_connection_arn` `service.repository_id`	Nom du service et référentiel de code
	input	`service_instance.inputs.input-name`	Entrées d'instance de service définies par le schéma
	collection	`{% for service_instance in service_instances %}...{% endfor %}`	Ensemble d'instances de service que vous pouvez parcourir en boucle
Composant	ressource	`environment.name` `environment.account_id`	Nom de l'environnement et ID de Compte AWS compte
	output	`environment.outputs.output-name`	Sorties de fichiers iAC de l'environnement
	ressource	`service.branch_name` `service.name` `service.repository_connection_arn` `service.repository_id`	Nom du service et référentiel de code (composants attachés)
	ressource	`service_instance.name`	Nom de l'instance de service (composants attachés)
	input	`service_instance.inputs.input-name`	Entrées d'instance de service définies par le schéma (composants attachés)
	ressource	`component.name`	Nom du composant

Pour plus d'informations et des exemples, consultez les sous-rubriques relatives aux paramètres des fichiers modèles IaC pour différents types de ressources et différents langages de modèles.

Rubriques

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Création de modèles et d'ensembles

Paramètres CloudFormation IaC de l'environnement