@aws-cdk/aws-imagebuilder-alpha.SSMParameterConfigurations

Experimental

@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

SSMParameterConfigurations Struct

The SSM parameters to create or update for the distributed AMIs.

Stability

Experimental

Source

lib/distribution-configuration.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as imagebuilder_alpha from '@aws-cdk/aws-imagebuilder-alpha';
import { aws_ssm as ssm } from 'aws-cdk-lib';

declare const stringParameter: ssm.StringParameter;
const sSMParameterConfigurations: imagebuilder_alpha.SSMParameterConfigurations = {
  parameter: stringParameter,

  // the properties below are optional
  amiAccount: 'amiAccount',
  dataType: ssm.ParameterDataType.TEXT,
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_imagebuilder_alpha as imagebuilder_alpha
from aws_cdk import aws_ssm as ssm

# string_parameter: ssm.StringParameter

s_sm_parameter_configurations = imagebuilder_alpha.SSMParameterConfigurations(
    parameter=string_parameter,

    # the properties below are optional
    ami_account="amiAccount",
    data_type=ssm.ParameterDataType.TEXT
)

// 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.alpha.*;
import software.amazon.awscdk.services.ssm.*;

StringParameter stringParameter;

SSMParameterConfigurations sSMParameterConfigurations = SSMParameterConfigurations.builder()
        .parameter(stringParameter)

        // the properties below are optional
        .amiAccount("amiAccount")
        .dataType(ParameterDataType.TEXT)
        .build();

// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ImageBuilder.Alpha;
using Amazon.CDK.AWS.SSM;

StringParameter stringParameter;

var sSMParameterConfigurations = new SSMParameterConfigurations {
    Parameter = stringParameter,

    // the properties below are optional
    AmiAccount = "amiAccount",
    DataType = ParameterDataType.TEXT
};

// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import imagebuilder_alpha "github.com/aws/aws-cdk-go/awsimagebuilderalpha"
import "github.com/aws/aws-cdk-go/awscdk"

var stringParameter StringParameter

sSMParameterConfigurations := &SSMParameterConfigurations{
	Parameter: stringParameter,

	// the properties below are optional
	AmiAccount: jsii.String("amiAccount"),
	DataType: awscdk.Aws_ssm.ParameterDataType_TEXT,
}

Properties

amiAccount?optionalstringami_account?optionalstramiAccount?optionalStringAmiAccount?optionalstringAmiAccount?optional*string#

The AWS account ID that will own the SSM parameter in the given region.

Default: The current account is used

This must be one of the target accounts that was included in the list of AMI distribution target accounts

dataType?optionalParameterDataTypedata_type?optionalParameterDataTypedataType?optionalParameterDataTypeDataType?optionalParameterDataTypeDataType?optionalParameterDataType#

The data type of the SSM parameter.

Default: ssm.ParameterDataType.AWS_EC2_IMAGE

parameterIStringParameterparameterIStringParameterparameterIStringParameterParameterIStringParameterParameterIStringParameterrequired#

The SSM parameter to create or update.