Interface CfnDistributionConfigurationPropsMixin.ISsmParameterConfigurationProperty

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

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ImageBuilder

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnDistributionConfigurationPropsMixin.ISsmParameterConfigurationProperty

Syntax (vb)

Public Interface CfnDistributionConfigurationPropsMixin.ISsmParameterConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.ImageBuilder;

             var ssmParameterConfigurationProperty = new SsmParameterConfigurationProperty {
                 AmiAccountId = "amiAccountId",
                 DataType = "dataType",
                 ParameterName = "parameterName"
             };

Synopsis

Properties

AmiAccountId	Specify the account that will own the Parameter in a given Region.
DataType	The data type specifies what type of value the Parameter contains.
ParameterName	This is the name of the Parameter in the target Region or account.

Properties

AmiAccountId

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

string? AmiAccountId { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-amiaccountid

DataType

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

string? DataType { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-datatype

ParameterName

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

string? ParameterName { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-parametername