Interface CfnFramework.FrameworkControlProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFramework.FrameworkControlProperty.Jsii$Proxy
Enclosing class:
CfnFramework

@Stability(Stable) public static interface CfnFramework.FrameworkControlProperty extends software.amazon.jsii.JsiiSerializable
Contains detailed information about all of the controls of a framework.

Each framework must contain at least one control.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backup.*;
 Object controlScope;
 FrameworkControlProperty frameworkControlProperty = FrameworkControlProperty.builder()
         .controlName("controlName")
         // the properties below are optional
         .controlInputParameters(List.of(ControlInputParameterProperty.builder()
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .controlScope(controlScope)
         .build();
 
  • Method Details

    • getControlName

      @Stability(Stable) @NotNull String getControlName()
      The name of a control.

      This name is between 1 and 256 characters.

    • getControlInputParameters

      @Stability(Stable) @Nullable default Object getControlInputParameters()
      A list of ParameterName and ParameterValue pairs.
    • getControlScope

      @Stability(Stable) @Nullable default Object getControlScope()
      The scope of a control.

      The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. For more information, see ControlScope .

    • builder

      @Stability(Stable) static CfnFramework.FrameworkControlProperty.Builder builder()
      Returns:
      a CfnFramework.FrameworkControlProperty.Builder of CfnFramework.FrameworkControlProperty