Interface DescribeFrameworkResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,BackupResponse.Builder
,Buildable
,CopyableBuilder<DescribeFrameworkResponse.Builder,
,DescribeFrameworkResponse> SdkBuilder<DescribeFrameworkResponse.Builder,
,DescribeFrameworkResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeFrameworkResponse
-
Method Summary
Modifier and TypeMethodDescriptioncreationTime
(Instant creationTime) The date and time that a framework is created, in ISO 8601 representation.deploymentStatus
(String deploymentStatus) The deployment status of a framework.frameworkArn
(String frameworkArn) An Amazon Resource Name (ARN) that uniquely identifies a resource.frameworkControls
(Collection<FrameworkControl> frameworkControls) A list of the controls that make up the framework.frameworkControls
(Consumer<FrameworkControl.Builder>... frameworkControls) A list of the controls that make up the framework.frameworkControls
(FrameworkControl... frameworkControls) A list of the controls that make up the framework.frameworkDescription
(String frameworkDescription) An optional description of the framework.frameworkName
(String frameworkName) The unique name of a framework.frameworkStatus
(String frameworkStatus) A framework consists of one or more controls.idempotencyToken
(String idempotencyToken) A customer-chosen string that you can use to distinguish between otherwise identical calls toDescribeFrameworkOutput
.Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupResponse.Builder
build, responseMetadata, responseMetadata
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, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
frameworkName
The unique name of a framework.
- Parameters:
frameworkName
- The unique name of a framework.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
frameworkArn
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- Parameters:
frameworkArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
frameworkDescription
An optional description of the framework.
- Parameters:
frameworkDescription
- An optional description of the framework.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
frameworkControls
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
- Parameters:
frameworkControls
- A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
frameworkControls
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
- Parameters:
frameworkControls
- A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
frameworkControls
DescribeFrameworkResponse.Builder frameworkControls(Consumer<FrameworkControl.Builder>... frameworkControls) A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
This is a convenience method that creates an instance of theFrameworkControl.Builder
avoiding the need to create one manually viaFrameworkControl.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toframeworkControls(List<FrameworkControl>)
.- Parameters:
frameworkControls
- a consumer that will call methods onFrameworkControl.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
creationTime
The date and time that a framework is created, in ISO 8601 representation. The value of
CreationTime
is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.- Parameters:
creationTime
- The date and time that a framework is created, in ISO 8601 representation. The value ofCreationTime
is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deploymentStatus
The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
- Parameters:
deploymentStatus
- The deployment status of a framework. The statuses are:CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
frameworkStatus
A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
-
ACTIVE
when recording is turned on for all resources governed by the framework. -
PARTIALLY_ACTIVE
when recording is turned off for at least one resource governed by the framework. -
INACTIVE
when recording is turned off for all resources governed by the framework. -
UNAVAILABLE
when Backup is unable to validate recording status at this time.
- Parameters:
frameworkStatus
- A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:-
ACTIVE
when recording is turned on for all resources governed by the framework. -
PARTIALLY_ACTIVE
when recording is turned off for at least one resource governed by the framework. -
INACTIVE
when recording is turned off for all resources governed by the framework. -
UNAVAILABLE
when Backup is unable to validate recording status at this time.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
idempotencyToken
A customer-chosen string that you can use to distinguish between otherwise identical calls to
DescribeFrameworkOutput
. Retrying a successful request with the same idempotency token results in a success message with no action taken.- Parameters:
idempotencyToken
- A customer-chosen string that you can use to distinguish between otherwise identical calls toDescribeFrameworkOutput
. Retrying a successful request with the same idempotency token results in a success message with no action taken.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-