Class ApplyCloudFormationInitOptions.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.ec2.ApplyCloudFormationInitOptions.Jsii$Proxy
All Implemented Interfaces:
ApplyCloudFormationInitOptions, software.amazon.jsii.JsiiSerializable
Enclosing interface:
ApplyCloudFormationInitOptions

@Stability(Stable) @Internal public static final class ApplyCloudFormationInitOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ApplyCloudFormationInitOptions
An implementation for ApplyCloudFormationInitOptions
  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.
    • Jsii$Proxy

      protected Jsii$Proxy(ApplyCloudFormationInitOptions.Builder builder)
      Constructor that initializes the object based on literal property values passed by the ApplyCloudFormationInitOptions.Builder.
  • Method Details

    • getConfigSets

      public final List<String> getConfigSets()
      Description copied from interface: ApplyCloudFormationInitOptions
      ConfigSet to activate.

      Default: ['default']

      Specified by:
      getConfigSets in interface ApplyCloudFormationInitOptions
    • getEmbedFingerprint

      public final Boolean getEmbedFingerprint()
      Description copied from interface: ApplyCloudFormationInitOptions
      Force instance replacement by embedding a config fingerprint.

      If true (the default), a hash of the config will be embedded into the UserData, so that if the config changes, the UserData changes.

      • If the EC2 instance is instance-store backed or userDataCausesReplacement is set, this will cause the instance to be replaced and the new configuration to be applied.
      • If the instance is EBS-backed and userDataCausesReplacement is not set, the change of UserData will make the instance restart but not be replaced, and the configuration will not be applied automatically.

      If false, no hash will be embedded, and if the CloudFormation Init config changes nothing will happen to the running instance. If a config update introduces errors, you will not notice until after the CloudFormation deployment successfully finishes and the next instance fails to launch.

      Default: true

      Specified by:
      getEmbedFingerprint in interface ApplyCloudFormationInitOptions
    • getIgnoreFailures

      public final Boolean getIgnoreFailures()
      Description copied from interface: ApplyCloudFormationInitOptions
      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.

      Default: false

      Specified by:
      getIgnoreFailures in interface ApplyCloudFormationInitOptions
    • getIncludeRole

      public final Boolean getIncludeRole()
      Description copied from interface: ApplyCloudFormationInitOptions
      Include --role argument when running cfn-init and cfn-signal commands.

      This will be the IAM instance profile attached to the EC2 instance

      Default: false

      Specified by:
      getIncludeRole in interface ApplyCloudFormationInitOptions
    • getIncludeUrl

      public final Boolean getIncludeUrl()
      Description copied from interface: ApplyCloudFormationInitOptions
      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

      Default: false

      Specified by:
      getIncludeUrl in interface ApplyCloudFormationInitOptions
    • getPrintLog

      public final Boolean getPrintLog()
      Description copied from interface: ApplyCloudFormationInitOptions
      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).

      Default: true

      Specified by:
      getPrintLog in interface ApplyCloudFormationInitOptions
    • getTimeout

      public final Duration getTimeout()
      Description copied from interface: ApplyCloudFormationInitOptions
      Timeout waiting for the configuration to be applied.

      Default: Duration.minutes(5)

      Specified by:
      getTimeout in interface ApplyCloudFormationInitOptions
    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object