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

Interface CreateMaintenanceWindowRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateMaintenanceWindowRequest.Builder,CreateMaintenanceWindowRequest>, SdkBuilder<CreateMaintenanceWindowRequest.Builder,CreateMaintenanceWindowRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
CreateMaintenanceWindowRequest
public static interface CreateMaintenanceWindowRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateMaintenanceWindowRequest.Builder,CreateMaintenanceWindowRequest>

  • Method Details

    • name

      CreateMaintenanceWindowRequest.Builder name(String name)

      The name of the maintenance window.

      Parameters:
      name - The name of the maintenance window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateMaintenanceWindowRequest.Builder description(String description)

      An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

      Parameters:
      description - An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startDate

      CreateMaintenanceWindowRequest.Builder startDate(String startDate)

      The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

      Parameters:
      startDate - The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endDate

      CreateMaintenanceWindowRequest.Builder endDate(String endDate)

      The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

      Parameters:
      endDate - The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedule

      CreateMaintenanceWindowRequest.Builder schedule(String schedule)

      The schedule of the maintenance window in the form of a cron or rate expression.

      Parameters:
      schedule - The schedule of the maintenance window in the form of a cron or rate expression.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleTimezone

      CreateMaintenanceWindowRequest.Builder scheduleTimezone(String scheduleTimezone)

      The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

      Parameters:
      scheduleTimezone - The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleOffset

      CreateMaintenanceWindowRequest.Builder scheduleOffset(Integer scheduleOffset)

      The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

      For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

      cron(30 23 ? * TUE#3 *)

      If the schedule offset is 2, the maintenance window won't run until two days later.

      Parameters:
      scheduleOffset - The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

      For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

      cron(30 23 ? * TUE#3 *)

      If the schedule offset is 2, the maintenance window won't run until two days later.

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

    • duration

      CreateMaintenanceWindowRequest.Builder duration(Integer duration)

      The duration of the maintenance window in hours.

      Parameters:
      duration - The duration of the maintenance window in hours.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cutoff

      CreateMaintenanceWindowRequest.Builder cutoff(Integer cutoff)

      The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

      Parameters:
      cutoff - The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowUnassociatedTargets

      CreateMaintenanceWindowRequest.Builder allowUnassociatedTargets(Boolean allowUnassociatedTargets)

      Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.

      If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

      Parameters:
      allowUnassociatedTargets - Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.

      If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

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

    • clientToken

      CreateMaintenanceWindowRequest.Builder clientToken(String clientToken)

      User-provided idempotency token.

      Parameters:
      clientToken - User-provided idempotency token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateMaintenanceWindowRequest.Builder tags(Collection<Tag> tags)

      Optional metadata that you assign to a resource. 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 maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:

      • Key=TaskType,Value=AgentUpdate

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      To add tags to an existing maintenance window, use the AddTagsToResource operation.

      Parameters:
      tags - Optional metadata that you assign to a resource. 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 maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:

      • Key=TaskType,Value=AgentUpdate

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      To add tags to an existing maintenance window, use the AddTagsToResource operation.

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

    • tags

      CreateMaintenanceWindowRequest.Builder tags(Tag... tags)

      Optional metadata that you assign to a resource. 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 maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:

      • Key=TaskType,Value=AgentUpdate

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      To add tags to an existing maintenance window, use the AddTagsToResource operation.

      Parameters:
      tags - Optional metadata that you assign to a resource. 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 maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:

      • Key=TaskType,Value=AgentUpdate

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      To add tags to an existing maintenance window, use the AddTagsToResource operation.

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

    • tags

      CreateMaintenanceWindowRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Optional metadata that you assign to a resource. 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 maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs:

      • Key=TaskType,Value=AgentUpdate

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      To add tags to an existing maintenance window, use the AddTagsToResource operation.

      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<Tag>).

      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:

    • overrideConfiguration

      CreateMaintenanceWindowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateMaintenanceWindowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.