Interface ControlSummary.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<ControlSummary.Builder,,ControlSummary> SdkBuilder<ControlSummary.Builder,,ControlSummary> SdkPojo
- Enclosing class:
ControlSummary
-
Method Summary
Modifier and TypeMethodDescriptionA list of alternative identifiers for the control.aliases(Collection<String> aliases) A list of alternative identifiers for the control.The Amazon Resource Name (ARN) of the control.An enumerated type, with the following possible values:behavior(ControlBehavior behavior) An enumerated type, with the following possible values:createTime(Instant createTime) A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.description(String description) A description of the control, as it may appear in the console.governedProviders(String... governedProviders) A list of providers whose resources are governed by this control.governedProviders(Collection<String> governedProviders) A list of providers whose resources are governed by this control.governedResources(String... governedResources) A list of resource types that are governed by this control.governedResources(Collection<String> governedResources) A list of resource types that are governed by this control.default ControlSummary.Builderimplementation(Consumer<ImplementationSummary.Builder> implementation) An object of typeImplementationSummarythat describes how the control is implemented.implementation(ImplementationSummary implementation) An object of typeImplementationSummarythat describes how the control is implemented.The display name of the control.parameterRequirementSummary(String parameterRequirementSummary) A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters.parameterRequirementSummary(ParameterRequirementSummary parameterRequirementSummary) A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters.An enumerated type, with the following possible values:severity(ControlSeverity severity) An enumerated type, with the following possible values:Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the control.
- Parameters:
arn- The Amazon Resource Name (ARN) of the control.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aliases
A list of alternative identifiers for the control. These are human-readable designators, such as
SH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.- Parameters:
aliases- A list of alternative identifiers for the control. These are human-readable designators, such asSH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aliases
A list of alternative identifiers for the control. These are human-readable designators, such as
SH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.- Parameters:
aliases- A list of alternative identifiers for the control. These are human-readable designators, such asSH.S3.1. Several aliases can refer to the same control across different Amazon Web Services services or compliance frameworks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The display name of the control.
- Parameters:
name- The display name of the control.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the control, as it may appear in the console. Describes the functionality of the control.
- Parameters:
description- A description of the control, as it may appear in the console. Describes the functionality of the control.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
behavior
An enumerated type, with the following possible values:
- Parameters:
behavior- An enumerated type, with the following possible values:- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
behavior
An enumerated type, with the following possible values:
- Parameters:
behavior- An enumerated type, with the following possible values:- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
severity
An enumerated type, with the following possible values:
- Parameters:
severity- An enumerated type, with the following possible values:- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
severity
An enumerated type, with the following possible values:
- Parameters:
severity- An enumerated type, with the following possible values:- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
parameterRequirementSummary
A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.
- Parameters:
parameterRequirementSummary- A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
parameterRequirementSummary
ControlSummary.Builder parameterRequirementSummary(ParameterRequirementSummary parameterRequirementSummary) A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.
- Parameters:
parameterRequirementSummary- A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
implementation
An object of type
ImplementationSummarythat describes how the control is implemented.- Parameters:
implementation- An object of typeImplementationSummarythat describes how the control is implemented.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
implementation
default ControlSummary.Builder implementation(Consumer<ImplementationSummary.Builder> implementation) An object of type
This is a convenience method that creates an instance of theImplementationSummarythat describes how the control is implemented.ImplementationSummary.Builderavoiding the need to create one manually viaImplementationSummary.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toimplementation(ImplementationSummary).- Parameters:
implementation- a consumer that will call methods onImplementationSummary.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createTime
A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.
- Parameters:
createTime- A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
governedResources
A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If
GovernedResourcescannot be represented by available resource types, it’s returned as an empty list.- Parameters:
governedResources- A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. IfGovernedResourcescannot be represented by available resource types, it’s returned as an empty list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
governedResources
A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If
GovernedResourcescannot be represented by available resource types, it’s returned as an empty list.- Parameters:
governedResources- A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. IfGovernedResourcescannot be represented by available resource types, it’s returned as an empty list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
governedProviders
A list of providers whose resources are governed by this control. For example, a value of
AWSindicates that the control governs Amazon Web Services resources.- Parameters:
governedProviders- A list of providers whose resources are governed by this control. For example, a value ofAWSindicates that the control governs Amazon Web Services resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
governedProviders
A list of providers whose resources are governed by this control. For example, a value of
AWSindicates that the control governs Amazon Web Services resources.- Parameters:
governedProviders- A list of providers whose resources are governed by this control. For example, a value ofAWSindicates that the control governs Amazon Web Services resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-