Package software.amazon.awscdk.services.imagebuilder

Interface CfnDistributionConfiguration.SsmParameterConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistributionConfiguration.SsmParameterConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDistributionConfiguration

@Stability(Stable)
public static interface CfnDistributionConfiguration.SsmParameterConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 SsmParameterConfigurationProperty ssmParameterConfigurationProperty = SsmParameterConfigurationProperty.builder()
         .parameterName("parameterName")
         // the properties below are optional
         .amiAccountId("amiAccountId")
         .dataType("dataType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDistributionConfiguration.SsmParameterConfigurationProperty.Builder	A builder for CfnDistributionConfiguration.SsmParameterConfigurationProperty
static final class	CfnDistributionConfiguration.SsmParameterConfigurationProperty.Jsii$Proxy	An implementation for CfnDistributionConfiguration.SsmParameterConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDistributionConfiguration.SsmParameterConfigurationProperty.Builder	builder()
default String	getAmiAccountId()	Specify the account that will own the Parameter in a given Region.
default String	getDataType()	The data type specifies what type of value the Parameter contains.
String	getParameterName()	This is the name of the Parameter in the target Region or account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getParameterName

@Stability(Stable)
@NotNull
String getParameterName()

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.

See Also:

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

getAmiAccountId

@Stability(Stable)
@Nullable
default String getAmiAccountId()

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.

See Also:

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

getDataType

@Stability(Stable)
@Nullable
default String getDataType()

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

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

See Also:

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

builder

@Stability(Stable)
static CfnDistributionConfiguration.SsmParameterConfigurationProperty.Builder builder()

Returns:

a CfnDistributionConfiguration.SsmParameterConfigurationProperty.Builder of CfnDistributionConfiguration.SsmParameterConfigurationProperty