aws-cdk-lib.aws_imagebuilder.CfnDistributionConfiguration.SsmParameterConfigurationProperty

SsmParameterConfigurationProperty Struct

Configuration for a single Parameter in the AWS Systems Manager (SSM) Parameter Store in a given Region.

Source

Generated code

Type last changed

v2.195.0 · 7 May 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
const ssmParameterConfigurationProperty: imagebuilder.CfnDistributionConfiguration.SsmParameterConfigurationProperty = {
  parameterName: 'parameterName',

  // the properties below are optional
  amiAccountId: 'amiAccountId',
  dataType: 'dataType',
};

Properties

amiAccountIdstringami_account_idstramiAccountIdStringAmiAccountIdstringAmiAccountId*string#

Specify the account that will own the Parameter in a given Region.

During distribution, this account must be specified in distribution settings as a target account for the Region.

dataTypestringdata_typestrdataTypeStringDataTypestringDataType*string#

The data type specifies what type of value the Parameter contains.

We recommend that you use data type aws:ec2:image .

parameterNamestringparameter_namestrparameterNameStringParameterNamestringParameterName*stringrequired#

This is the name of the Parameter in the target Region or account.

The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter.