Interface ControlSummary.Builder

  • 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 as SH.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

      ControlSummary.Builder aliases(String... 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 as SH.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

      ControlSummary.Builder description(String 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

      ControlSummary.Builder behavior(String 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

      ControlSummary.Builder severity(String 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

      ControlSummary.Builder parameterRequirementSummary(String 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

      ControlSummary.Builder implementation(ImplementationSummary implementation)

      An object of type ImplementationSummary that describes how the control is implemented.

      Parameters:
      implementation - An object of type ImplementationSummary that 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 ImplementationSummary that describes how the control is implemented.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to implementation(ImplementationSummary).

      Parameters:
      implementation - a consumer that will call methods on ImplementationSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • createTime

      ControlSummary.Builder 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.

      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

      ControlSummary.Builder governedResources(Collection<String> 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 GovernedResources cannot 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. If GovernedResources cannot 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

      ControlSummary.Builder governedResources(String... 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 GovernedResources cannot 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. If GovernedResources cannot 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

      ControlSummary.Builder governedProviders(Collection<String> governedProviders)

      A list of providers whose resources are governed by this control. For example, a value of AWS indicates 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 of AWS indicates that the control governs Amazon Web Services resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • governedProviders

      ControlSummary.Builder governedProviders(String... governedProviders)

      A list of providers whose resources are governed by this control. For example, a value of AWS indicates 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 of AWS indicates that the control governs Amazon Web Services resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.