Class AttachInitOptions.Builder

java.lang.Object
software.amazon.awscdk.services.ec2.AttachInitOptions.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<AttachInitOptions>
Enclosing interface:
AttachInitOptions

@Stability(Stable) public static final class AttachInitOptions.Builder extends Object implements software.amazon.jsii.Builder<AttachInitOptions>
A builder for AttachInitOptions
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • instanceRole

      @Stability(Stable) public AttachInitOptions.Builder instanceRole(IRole instanceRole)
      Parameters:
      instanceRole - Instance role of the consuming instance or fleet. This parameter is required.
      Returns:
      this
    • platform

      @Stability(Stable) public AttachInitOptions.Builder platform(OperatingSystemType platform)
      Parameters:
      platform - OS Platform the init config will be used for. This parameter is required.
      Returns:
      this
    • userData

      @Stability(Stable) public AttachInitOptions.Builder userData(UserData userData)
      Parameters:
      userData - UserData to add commands to. This parameter is required.
      Returns:
      this
    • configSets

      @Stability(Stable) public AttachInitOptions.Builder configSets(List<String> configSets)
      Parameters:
      configSets - ConfigSet to activate.
      Returns:
      this
    • embedFingerprint

      @Stability(Stable) public AttachInitOptions.Builder embedFingerprint(Boolean embedFingerprint)
      Parameters:
      embedFingerprint - Whether to embed a hash into the userData. If true (the default), a hash of the config will be embedded into the UserData, so that if the config changes, the UserData changes and the instance will be replaced.

      If false, no such hash will be embedded, and if the CloudFormation Init config changes nothing will happen to the running instance.

      Returns:
      this
    • ignoreFailures

      @Stability(Stable) public AttachInitOptions.Builder ignoreFailures(Boolean ignoreFailures)
      Parameters:
      ignoreFailures - Don't fail the instance creation when cfn-init fails. You can use this to prevent CloudFormation from rolling back when instances fail to start up, to help in debugging.
      Returns:
      this
    • includeRole

      @Stability(Stable) public AttachInitOptions.Builder includeRole(Boolean includeRole)
      Parameters:
      includeRole - Include --role argument when running cfn-init and cfn-signal commands. This will be the IAM instance profile attached to the EC2 instance
      Returns:
      this
    • includeUrl

      @Stability(Stable) public AttachInitOptions.Builder includeUrl(Boolean includeUrl)
      Parameters:
      includeUrl - Include --url argument when running cfn-init and cfn-signal commands. This will be the cloudformation endpoint in the deployed region e.g. https://cloudformation.us-east-1.amazonaws.com
      Returns:
      this
    • printLog

      @Stability(Stable) public AttachInitOptions.Builder printLog(Boolean printLog)
      Parameters:
      printLog - Print the results of running cfn-init to the Instance System Log. By default, the output of running cfn-init is written to a log file on the instance. Set this to true to print it to the System Log (visible from the EC2 Console), false to not print it.

      (Be aware that the system log is refreshed at certain points in time of the instance life cycle, and successful execution may not always show up).

      Returns:
      this
    • signalResource

      @Stability(Stable) public AttachInitOptions.Builder signalResource(CfnResource signalResource)
      Parameters:
      signalResource - When provided, signals this resource instead of the attached resource. You can use this to support signaling LaunchTemplate while attaching AutoScalingGroup
      Returns:
      this
    • build

      @Stability(Stable) public AttachInitOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<AttachInitOptions>
      Returns:
      a new instance of AttachInitOptions
      Throws:
      NullPointerException - if any required attribute was not provided