Package software.amazon.awssdk.services.ssm.model

Class StartChangeRequestExecutionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssm.model.SsmRequest
software.amazon.awssdk.services.ssm.model.StartChangeRequestExecutionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartChangeRequestExecutionRequest.Builder,StartChangeRequestExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartChangeRequestExecutionRequest extends SsmRequest implements ToCopyableBuilder<StartChangeRequestExecutionRequest.Builder,StartChangeRequestExecutionRequest>

  • Method Details

    • scheduledTime

      public final Instant scheduledTime()

      The date and time specified in the change request to run the Automation runbooks.

      The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

      Returns:
      The date and time specified in the change request to run the Automation runbooks.

      The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

    • documentName

      public final String documentName()

      The name of the change template document to run during the runbook workflow.

      Returns:
      The name of the change template document to run during the runbook workflow.

    • documentVersion

      public final String documentVersion()

      The version of the change template document to run during the runbook workflow.

      Returns:
      The version of the change template document to run during the runbook workflow.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parameters

      public final Map<String,List<String>> parameters()

      A key-value map of parameters that match the declared parameters in the change template document.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

      Returns:
      A key-value map of parameters that match the declared parameters in the change template document.

    • changeRequestName

      public final String changeRequestName()

      The name of the change request associated with the runbook workflow to be run.

      Returns:
      The name of the change request associated with the runbook workflow to be run.

    • clientToken

      public final String clientToken()

      The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

      Returns:
      The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

    • autoApprove

      public final Boolean autoApprove()

      Indicates whether the change request can be approved automatically without the need for manual approvals.

      If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

      Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

      Returns:
      Indicates whether the change request can be approved automatically without the need for manual approvals.

      If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

      Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again OPEN.

    • hasRunbooks

      public final boolean hasRunbooks()
      For responses, this returns true if the service returned a value for the Runbooks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • runbooks

      public final List<Runbook> runbooks()

      Information about the Automation runbooks that are run during the runbook workflow.

      The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRunbooks() method.

      Returns:
      Information about the Automation runbooks that are run during the runbook workflow.

      The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

      • Key=Environment,Value=Production

      • Key=Region,Value=us-east-2

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

      • Key=Environment,Value=Production

      • Key=Region,Value=us-east-2

    • scheduledEndTime

      public final Instant scheduledEndTime()

      The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

      Returns:
      The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

    • changeDetails

      public final String changeDetails()

      User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

      Returns:
      User-provided details about the change. If no details are provided, content specified in the Template information section of the associated change template is added.

    • toBuilder

      public StartChangeRequestExecutionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartChangeRequestExecutionRequest.Builder,StartChangeRequestExecutionRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • builder

      public static StartChangeRequestExecutionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartChangeRequestExecutionRequest.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.