Package software.amazon.awscdk.services.backup

Class CfnFramework

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.backup.CfnFramework
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.654Z") @Stability(Stable) public class CfnFramework extends CfnResource implements IInspectable
A CloudFormation AWS::Backup::Framework.

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

For a sample AWS CloudFormation template, see the AWS Backup Developer Guide .

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;
 CfnFramework cfnFramework = CfnFramework.Builder.create(this, "MyCfnFramework")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFramework

      protected CfnFramework(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFramework

      protected CfnFramework(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFramework

      @Stability(Stable) public CfnFramework(@NotNull Construct scope, @NotNull String id, @NotNull CfnFrameworkProps props)
      Create a new AWS::Backup::Framework.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The UTC time when you created your framework.

    • getAttrDeploymentStatus

      @Stability(Stable) @NotNull public String getAttrDeploymentStatus()
      Depolyment status refers to whether your framework has completed deployment.

      This status is usually Completed , but might also be Create in progress or another status. For a list of statuses, see Framework compliance status in the Developer Guide .

    • getAttrFrameworkArn

      @Stability(Stable) @NotNull public String getAttrFrameworkArn()
      The Amazon Resource Name (ARN) of your framework.

    • getAttrFrameworkStatus

      @Stability(Stable) @NotNull public String getAttrFrameworkStatus()
      Framework status refers to whether you have turned on resource tracking for all of your resources.

      This status is Active when you turn on all resources the framework evaluates. For other statuses and steps to correct them, see Framework compliance status in the Developer Guide .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFrameworkControls

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

      Each framework must contain at least one control.

    • setFrameworkControls

      @Stability(Stable) public void setFrameworkControls(@NotNull IResolvable value)
      Contains detailed information about all of the controls of a framework.

      Each framework must contain at least one control.

    • setFrameworkControls

      @Stability(Stable) public void setFrameworkControls(@NotNull List<Object> value)
      Contains detailed information about all of the controls of a framework.

      Each framework must contain at least one control.

    • getFrameworkDescription

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

    • setFrameworkDescription

      @Stability(Stable) public void setFrameworkDescription(@Nullable String value)
      An optional description of the framework with a maximum 1,024 characters.

    • getFrameworkName

      @Stability(Stable) @Nullable public 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 (_).

    • setFrameworkName

      @Stability(Stable) public void setFrameworkName(@Nullable String value)
      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 public Object getFrameworkTags()
      A list of tags with which to tag your framework.

    • setFrameworkTags

      @Stability(Stable) public void setFrameworkTags(@Nullable IResolvable value)
      A list of tags with which to tag your framework.

    • setFrameworkTags

      @Stability(Stable) public void setFrameworkTags(@Nullable List<Object> value)
      A list of tags with which to tag your framework.