Class AmazonLinuxImageSsmParameterBaseProps
Base properties for an Amazon Linux SSM Parameter.
Inheritance
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AmazonLinuxImageSsmParameterBaseProps : Object, IAmazonLinuxImageSsmParameterBaseProps, IAmazonLinuxImageSsmParameterBaseOptions
Syntax (vb)
Public Class AmazonLinuxImageSsmParameterBaseProps
Inherits Object
Implements IAmazonLinuxImageSsmParameterBaseProps, IAmazonLinuxImageSsmParameterBaseOptions
Remarks
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 amazonLinuxImageSsmParameterBaseProps = new AmazonLinuxImageSsmParameterBaseProps {
ParameterName = "parameterName",
// the properties below are optional
CachedInContext = false,
UserData = userData
};
Synopsis
Constructors
AmazonLinuxImageSsmParameterBaseProps() |
Properties
CachedInContext | Whether the AMI ID is cached to be stable between deployments. |
ParameterName | The name of the SSM parameter that contains the AMI value. |
UserData | Initial user data. |
Constructors
AmazonLinuxImageSsmParameterBaseProps()
public AmazonLinuxImageSsmParameterBaseProps()
Properties
CachedInContext
Whether the AMI ID is cached to be stable between deployments.
public Nullable<bool> CachedInContext { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren't enough running instances in the AutoScalingGroup to reschedule the tasks on.
If set to true, the AMI ID will be cached in cdk.context.json
and the
same value will be used on future runs. Your instances will not be replaced
but your AMI version will grow old over time. To refresh the AMI lookup,
you will have to evict the value from the cache using the cdk context
command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
more information.
Can not be set to true
in environment-agnostic stacks.
Default: false
ParameterName
The name of the SSM parameter that contains the AMI value.
public string ParameterName { get; set; }
Property Value
System.String
UserData
Initial user data.
public UserData UserData { get; set; }
Property Value
Remarks
Default: - Empty UserData for Linux machines