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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.173Z")
 @Stability(value=Stable)
public class CfnFramework
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Backup::Framework`.

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 Example:
static interface	CfnFramework.FrameworkControlProperty Example:

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()
String	getAttrDeploymentStatus()
String	getAttrFrameworkArn()
String	getAttrFrameworkStatus()
protected Map<String,Object>	getCfnProperties()
Object	getFrameworkControls() `AWS::Backup::Framework.FrameworkControls`.
String	getFrameworkDescription() `AWS::Backup::Framework.FrameworkDescription`.
String	getFrameworkName() `AWS::Backup::Framework.FrameworkName`.
Object	getFrameworkTags() `AWS::Backup::Framework.FrameworkTags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFrameworkControls(IResolvable value) `AWS::Backup::Framework.FrameworkControls`.
void	setFrameworkControls(List<Object> value) `AWS::Backup::Framework.FrameworkControls`.
void	setFrameworkDescription(String value) `AWS::Backup::Framework.FrameworkDescription`.
void	setFrameworkName(String value) `AWS::Backup::Framework.FrameworkName`.
void	setFrameworkTags(IResolvable value) `AWS::Backup::Framework.FrameworkTags`.
void	setFrameworkTags(List<Object> value) `AWS::Backup::Framework.FrameworkTags`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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()

getAttrDeploymentStatus

@Stability(value=Stable)
 @NotNull
public String getAttrDeploymentStatus()

getAttrFrameworkArn

@Stability(value=Stable)
 @NotNull
public String getAttrFrameworkArn()

getAttrFrameworkStatus

@Stability(value=Stable)
 @NotNull
public String getAttrFrameworkStatus()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFrameworkControls

@Stability(value=Stable)
 @NotNull
public Object getFrameworkControls()

`AWS::Backup::Framework.FrameworkControls`.

setFrameworkControls

@Stability(value=Stable)
public void setFrameworkControls(@NotNull
                                                          IResolvable value)

`AWS::Backup::Framework.FrameworkControls`.

setFrameworkControls

@Stability(value=Stable)
public void setFrameworkControls(@NotNull
                                                          List<Object> value)

`AWS::Backup::Framework.FrameworkControls`.

getFrameworkDescription

@Stability(value=Stable)
 @Nullable
public String getFrameworkDescription()

`AWS::Backup::Framework.FrameworkDescription`.

setFrameworkDescription

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

`AWS::Backup::Framework.FrameworkDescription`.

getFrameworkName

@Stability(value=Stable)
 @Nullable
public String getFrameworkName()

`AWS::Backup::Framework.FrameworkName`.

setFrameworkName

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

`AWS::Backup::Framework.FrameworkName`.

getFrameworkTags

@Stability(value=Stable)
 @Nullable
public Object getFrameworkTags()

`AWS::Backup::Framework.FrameworkTags`.

setFrameworkTags

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

`AWS::Backup::Framework.FrameworkTags`.

setFrameworkTags

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

`AWS::Backup::Framework.FrameworkTags`.