software.amazon.awscdk.services.backup

Class CfnFramework

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.backup.CfnFramework

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.862Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnFramework.Builder A fluent builder for CfnFramework.
static interface	CfnFramework.ControlInputParameterProperty A list of parameters for a control.
static interface	CfnFramework.FrameworkControlProperty Contains detailed information about all of the controls of a framework.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFramework(software.constructs.Construct scope, String id, CfnFrameworkProps props) Create a new `AWS::Backup::Framework`.
protected	CfnFramework(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFramework(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
IResolvable	getAttrCreationTime() The UTC time when you created your framework.
String	getAttrDeploymentStatus() Depolyment status refers to whether your framework has completed deployment.
String	getAttrFrameworkArn() The Amazon Resource Name (ARN) of your framework.
String	getAttrFrameworkStatus() Framework status refers to whether you have turned on resource tracking for all of your resources.
protected Map<String,Object>	getCfnProperties()
Object	getFrameworkControls() Contains detailed information about all of the controls of a framework.
String	getFrameworkDescription() An optional description of the framework with a maximum 1,024 characters.
String	getFrameworkName() The unique name of a framework.
Object	getFrameworkTags() A list of tags with which to tag your framework.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFrameworkControls(IResolvable value) Contains detailed information about all of the controls of a framework.
void	setFrameworkControls(List<Object> value) Contains detailed information about all of the controls of a framework.
void	setFrameworkDescription(String value) An optional description of the framework with a maximum 1,024 characters.
void	setFrameworkName(String value) The unique name of a framework.
void	setFrameworkTags(IResolvable value) A list of tags with which to tag your framework.
void	setFrameworkTags(List<Object> value) A list of tags with which to tag your framework.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFramework

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

CfnFramework

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

CfnFramework

@Stability(value=Stable)
public CfnFramework(@NotNull
                                             software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public IResolvable getAttrCreationTime()

The UTC time when you created your framework.

getAttrDeploymentStatus

@Stability(value=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(value=Stable)
 @NotNull
public String getAttrFrameworkArn()

The Amazon Resource Name (ARN) of your framework.

getAttrFrameworkStatus

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFrameworkControls

@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getFrameworkDescription()

An optional description of the framework with a maximum 1,024 characters.

setFrameworkDescription

@Stability(value=Stable)
public void setFrameworkDescription(@Nullable
                                                             String value)

An optional description of the framework with a maximum 1,024 characters.

getFrameworkName

@Stability(value=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(value=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(value=Stable)
 @Nullable
public Object getFrameworkTags()

A list of tags with which to tag your framework.

setFrameworkTags

@Stability(value=Stable)
public void setFrameworkTags(@Nullable
                                                      IResolvable value)

A list of tags with which to tag your framework.

setFrameworkTags

@Stability(value=Stable)
public void setFrameworkTags(@Nullable
                                                      List<Object> value)

A list of tags with which to tag your framework.