Interface CfnFrameworkProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnFrameworkProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.660Z") @Stability(Stable) public interface CfnFrameworkProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnFramework.

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;
 CfnFrameworkProps cfnFrameworkProps = CfnFrameworkProps.builder()
         .frameworkControls(List.of(FrameworkControlProperty.builder()
                 .controlName("controlName")
                 // the properties below are optional
                 .controlInputParameters(List.of(ControlInputParameterProperty.builder()
                         .parameterName("parameterName")
                         .parameterValue("parameterValue")
                         .build()))
                 .controlScope(controlScope)
                 .build()))
         // the properties below are optional
         .frameworkDescription("frameworkDescription")
         .frameworkName("frameworkName")
         .frameworkTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 
  • Method Details

    • getFrameworkControls

      @Stability(Stable) @NotNull Object getFrameworkControls()
      Contains detailed information about all of the controls of a framework.

      Each framework must contain at least one control.

    • getFrameworkDescription

      @Stability(Stable) @Nullable default String getFrameworkDescription()
      An optional description of the framework with a maximum 1,024 characters.
    • getFrameworkName

      @Stability(Stable) @Nullable default String getFrameworkName()
      The unique name of a framework.

      This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    • getFrameworkTags

      @Stability(Stable) @Nullable default Object getFrameworkTags()
      A list of tags with which to tag your framework.
    • builder

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