Class CfnFramework

Creates a framework with one or more controls.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnFramework

Implements

IInspectable

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Backup

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFramework : CfnResource, IInspectable, ITaggableV2

Syntax (vb)

Public Class CfnFramework Inherits CfnResource Implements IInspectable, ITaggableV2

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Backup;

             var controlScope;

             var cfnFramework = new CfnFramework(this, "MyCfnFramework", new CfnFrameworkProps {
                 FrameworkControls = new [] { new FrameworkControlProperty {
                     ControlName = "controlName",

                     // the properties below are optional
                     ControlInputParameters = new [] { new ControlInputParameterProperty {
                         ParameterName = "parameterName",
                         ParameterValue = "parameterValue"
                     } },
                     ControlScope = controlScope
                 } },

                 // the properties below are optional
                 FrameworkDescription = "frameworkDescription",
                 FrameworkName = "frameworkName",
                 FrameworkTags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnFramework(Construct, string, ICfnFrameworkProps)

Creates a framework with one or more controls.

Properties

AttrCreationTime	The UTC time when you created your framework.
AttrDeploymentStatus	Depolyment status refers to whether your framework has completed deployment.
AttrFrameworkArn	The Amazon Resource Name (ARN) of your framework.
AttrFrameworkStatus	Framework status refers to whether you have turned on resource tracking for all of your resources.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Creates a framework with one or more controls.
FrameworkControls	Contains detailed information about all of the controls of a framework.
FrameworkDescription	An optional description of the framework with a maximum 1,024 characters.
FrameworkName	The unique name of a framework.
FrameworkTags	The tags to assign to your framework.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Creates a framework with one or more controls.

Constructors

CfnFramework(Construct, string, ICfnFrameworkProps)

Creates a framework with one or more controls.

public CfnFramework(Construct scope, string id, ICfnFrameworkProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnFrameworkProps

Resource properties.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

Properties

AttrCreationTime

The UTC time when you created your framework.

public virtual string AttrCreationTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreationTime

AttrDeploymentStatus

Depolyment status refers to whether your framework has completed deployment.

public virtual string AttrDeploymentStatus { get; }

Property Value

string

Remarks

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 .

CloudformationAttribute: DeploymentStatus

AttrFrameworkArn

The Amazon Resource Name (ARN) of your framework.

public virtual string AttrFrameworkArn { get; }

Property Value

string

Remarks

CloudformationAttribute: FrameworkArn

AttrFrameworkStatus

Framework status refers to whether you have turned on resource tracking for all of your resources.

public virtual string AttrFrameworkStatus { get; }

Property Value

string

Remarks

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 .

CloudformationAttribute: FrameworkStatus

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

CfnProperties

Creates a framework with one or more controls.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

FrameworkControls

Contains detailed information about all of the controls of a framework.

public virtual object FrameworkControls { get; set; }

Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

FrameworkDescription

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

public virtual string? FrameworkDescription { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

FrameworkName

The unique name of a framework.

public virtual string? FrameworkName { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

FrameworkTags

The tags to assign to your framework.

public virtual ICfnTag[]? FrameworkTags { get; set; }

Property Value

ICfnTag[]

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a framework with one or more controls.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html

CloudformationResource: AWS::Backup::Framework

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggableV2