How to set ami name through cloud formation image builder

Question

I have a `Cloud Formation` `yaml` the builds an image using image builder services.  
I don't seem to find a way to change the ami name.  
It always uses the `AWS::ImageBuilder::ImageRecipe`'s `Properties.Name` + some date.

How can I override it or change it after build is done?

Thanks

Dhinesh · Accepted Answer

Hello

To customize the name of your output AMI built with Image Builder, update the [distribution configuration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-amidistributionconfiguration-name:~:text=LaunchPermissionConfiguration%3A%20%0A%20%20%20%20LaunchPermissionConfiguration-,Name,-%3A%20String%0A%20%20TargetAccountIds) name in your CloudFormation template.

Additionally, you may consider adding extra details to your custom AMI name. [Refer](https://docs.aws.amazon.com/imagebuilder/latest/userguide/tag-resources.html).

```
DistributionConfiguration:
            Name: !Sub '${OutputAMIname}-{{ imagebuilder:buildDate }}-{{ imagebuilder:buildVersion }}'
```

Dhinesh · Answer

Adding a build date to AMI created through ImageBuilder is to maintain uniqueness for the AMI. 
Try to use [AMItags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-amidistributionconfiguration.html#cfn-imagebuilder-distributionconfiguration-amidistributionconfiguration-amitags:~:text=Properties-,AmiTags,-The%20tags%20to) - Name: {Custom_AMI_Name_you_want}.

How to set ami name through cloud formation image builder

Add your answer

Relevant content