Interface StartZonalShiftRequest.Builder
- All Superinterfaces:
ArcZonalShiftRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<StartZonalShiftRequest.Builder,
,StartZonalShiftRequest> SdkBuilder<StartZonalShiftRequest.Builder,
,StartZonalShiftRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartZonalShiftRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe Availability Zone (for example,use1-az1
) that traffic is moved away from for a resource when you start a zonal shift.A comment that you enter about the zonal shift.The length of time that you want a zonal shift to be active, which ARC converts to an expiry time (expiration time).overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.resourceIdentifier
(String resourceIdentifier) The identifier for the resource that Amazon Web Services shifts traffic for.Methods inherited from interface software.amazon.awssdk.services.arczonalshift.model.ArcZonalShiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
resourceIdentifier
The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.
Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:
- Parameters:
resourceIdentifier
- The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
awayFrom
The Availability Zone (for example,
use1-az1
) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.- Parameters:
awayFrom
- The Availability Zone (for example,use1-az1
) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expiresIn
The length of time that you want a zonal shift to be active, which ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).
If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.
To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
-
A lowercase letter m: To specify that the value is in minutes.
-
A lowercase letter h: To specify that the value is in hours.
For example:
20h
means the zonal shift expires in 20 hours.120m
means the zonal shift expires in 120 minutes (2 hours).- Parameters:
expiresIn
- The length of time that you want a zonal shift to be active, which ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.
To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:
-
A lowercase letter m: To specify that the value is in minutes.
-
A lowercase letter h: To specify that the value is in hours.
For example:
20h
means the zonal shift expires in 20 hours.120m
means the zonal shift expires in 120 minutes (2 hours).-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
comment
A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.
- Parameters:
comment
- A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
StartZonalShiftRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartZonalShiftRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-