Class CfnFramework
A CloudFormation AWS::Backup::Framework
.
Inherited Members
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.AWS.Backup.dll
Syntax (csharp)
public class CfnFramework : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFramework
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::Backup::Framework
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html
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) | Create a new |
CfnFramework(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFramework(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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. |
CfnProperties | |
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 | A list of tags with which to tag your framework. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFramework(Construct, String, ICfnFrameworkProps)
Create a new AWS::Backup::Framework
.
public CfnFramework(Construct scope, string id, ICfnFrameworkProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnFrameworkProps
- resource properties.
CfnFramework(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFramework(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFramework(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFramework(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrCreationTime
The UTC time when you created your framework.
public virtual string AttrCreationTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreationTime
AttrDeploymentStatus
Depolyment status refers to whether your framework has completed deployment.
public virtual string AttrDeploymentStatus { get; }
Property Value
System.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
System.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
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
FrameworkControls
Contains detailed information about all of the controls of a framework.
public virtual object FrameworkControls { get; set; }
Property Value
System.Object
Remarks
Each framework must contain at least one control.
FrameworkDescription
An optional description of the framework with a maximum 1,024 characters.
public virtual string FrameworkDescription { get; set; }
Property Value
System.String
Remarks
FrameworkName
The unique name of a framework.
public virtual string FrameworkName { get; set; }
Property Value
System.String
Remarks
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 (_).
FrameworkTags
A list of tags with which to tag your framework.
public virtual object FrameworkTags { get; set; }
Property Value
System.Object
Remarks
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>