Package software.amazon.awscdk.services.ec2

Class ResolveSsmParameterAtLaunchImage.Builder

java.lang.Object
software.amazon.awscdk.services.ec2.ResolveSsmParameterAtLaunchImage.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<ResolveSsmParameterAtLaunchImage>
Enclosing class:
ResolveSsmParameterAtLaunchImage
@Stability(Stable) public static final class ResolveSsmParameterAtLaunchImage.Builder extends Object implements software.amazon.jsii.Builder<ResolveSsmParameterAtLaunchImage>
A fluent builder for ResolveSsmParameterAtLaunchImage.

  • Method Details

    • create

      @Stability(Stable) public static ResolveSsmParameterAtLaunchImage.Builder create(String parameterName)
      Parameters:
      parameterName - This parameter is required.
      Returns:
      a new instance of ResolveSsmParameterAtLaunchImage.Builder.

    • cachedInContext

      @Stability(Stable) public ResolveSsmParameterAtLaunchImage.Builder cachedInContext(Boolean cachedInContext)
      Whether the AMI ID is cached to be stable between deployments.

      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

      Parameters:
      cachedInContext - Whether the AMI ID is cached to be stable between deployments. This parameter is required.
      Returns:
      this

    • os

      @Stability(Stable) public ResolveSsmParameterAtLaunchImage.Builder os(OperatingSystemType os)
      Operating system.

      Default: OperatingSystemType.LINUX

      Parameters:
      os - Operating system. This parameter is required.
      Returns:
      this

    • parameterVersion

      @Stability(Stable) public ResolveSsmParameterAtLaunchImage.Builder parameterVersion(String parameterVersion)
      The version of the SSM parameter.

      Default: no version specified.

      Parameters:
      parameterVersion - The version of the SSM parameter. This parameter is required.
      Returns:
      this

    • userData

      @Stability(Stable) public ResolveSsmParameterAtLaunchImage.Builder userData(UserData userData)
      Custom UserData.

      Default: - UserData appropriate for the OS

      Parameters:
      userData - Custom UserData. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public ResolveSsmParameterAtLaunchImage build()
      Specified by:
      build in interface software.amazon.jsii.Builder<ResolveSsmParameterAtLaunchImage>
      Returns:
      a newly built instance of ResolveSsmParameterAtLaunchImage.