Class ResolveSsmParameterAtLaunchImage
Select the image based on a given SSM parameter at instance launch time.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ResolveSsmParameterAtLaunchImage : DeputyBase, IMachineImage
Syntax (vb)
Public Class ResolveSsmParameterAtLaunchImage
Inherits DeputyBase
Implements IMachineImage
Remarks
This Machine Image comes with an imageId as resolve:ssm:parameter-name
or resolve:ssm:parameter-name:version
format
as described in the document:
See: https://docs.aws.amazon.com/autoscaling/ec2/userguide/using-systems-manager-parameters.html
The AMI ID would be selected at instance launch time.
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.AWS.EC2;
UserData userData;
var resolveSsmParameterAtLaunchImage = new ResolveSsmParameterAtLaunchImage("parameterName", new SsmParameterImageOptions {
CachedInContext = false,
Os = OperatingSystemType.LINUX,
ParameterVersion = "parameterVersion",
UserData = userData
});
Synopsis
Constructors
ResolveSsmParameterAtLaunchImage(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
ResolveSsmParameterAtLaunchImage(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
ResolveSsmParameterAtLaunchImage(String, ISsmParameterImageOptions) |
Properties
ParameterName | Name of the SSM parameter we're looking up. |
Methods
GetImage(Construct) | Return the image to use in the given context. |
Constructors
ResolveSsmParameterAtLaunchImage(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected ResolveSsmParameterAtLaunchImage(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
ResolveSsmParameterAtLaunchImage(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected ResolveSsmParameterAtLaunchImage(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
ResolveSsmParameterAtLaunchImage(String, ISsmParameterImageOptions)
public ResolveSsmParameterAtLaunchImage(string parameterName, ISsmParameterImageOptions props = null)
Parameters
- parameterName System.String
- props ISsmParameterImageOptions
Properties
ParameterName
Name of the SSM parameter we're looking up.
public virtual string ParameterName { get; }
Property Value
System.String
Methods
GetImage(Construct)
Return the image to use in the given context.
public virtual IMachineImageConfig GetImage(Construct _)
Parameters
- _ Constructs.Construct
Returns