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

Interface StartChangeRequestExecutionRequest.Builder

    • Method Detail

      • scheduledTime

        StartChangeRequestExecutionRequest.Builder scheduledTime​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • documentName

        StartChangeRequestExecutionRequest.Builder documentName​(String documentName)

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

        Parameters:
        documentName - The name of the change template document to run during the runbook workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentVersion

        StartChangeRequestExecutionRequest.Builder documentVersion​(String documentVersion)

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

        Parameters:
        documentVersion - The version of the change template document to run during the runbook workflow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • parameters

        StartChangeRequestExecutionRequest.Builder parameters​(Map<String,​? extends Collection<String>> parameters)

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

        Parameters:
        parameters - A key-value map of parameters that match the declared parameters in the change template document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • changeRequestName

        StartChangeRequestExecutionRequest.Builder changeRequestName​(String changeRequestName)

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

        Parameters:
        changeRequestName - The name of the change request associated with the runbook workflow to be run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        StartChangeRequestExecutionRequest.Builder clientToken​(String clientToken)

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

        Parameters:
        clientToken - The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoApprove

        StartChangeRequestExecutionRequest.Builder autoApprove​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • runbooks

        StartChangeRequestExecutionRequest.Builder runbooks​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • runbooks

        StartChangeRequestExecutionRequest.Builder runbooks​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • runbooks

        StartChangeRequestExecutionRequest.Builder runbooks​(Consumer<Runbook.Builder>... 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.

        This is a convenience method that creates an instance of the Runbook.Builder avoiding the need to create one manually via Runbook.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #runbooks(List).

        Parameters:
        runbooks - a consumer that will call methods on Runbook.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #runbooks(java.util.Collection)

      • tags

        StartChangeRequestExecutionRequest.Builder tags​(Collection<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

        The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.

        Parameters:
        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

        The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartChangeRequestExecutionRequest.Builder tags​(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

        The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.

        Parameters:
        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

        The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartChangeRequestExecutionRequest.Builder tags​(Consumer<Tag.Builder>... 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

        The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • scheduledEndTime

        StartChangeRequestExecutionRequest.Builder scheduledEndTime​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • changeDetails

        StartChangeRequestExecutionRequest.Builder changeDetails​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.