Skip to content
v2.277.0

FrameworkControlProperty Struct ​

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

Each framework must contain at least one control.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_backup as backup } from 'aws-cdk-lib';

declare const controlScope: any;
const frameworkControlProperty: backup.CfnFramework.FrameworkControlProperty = {
  controlName: 'controlName',

  // the properties below are optional
  controlInputParameters: [{
    parameterName: 'parameterName',
    parameterValue: 'parameterValue',
  }],
  controlScope: controlScope,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_backup as backup

# control_scope: Any

framework_control_property = backup.CfnFramework.FrameworkControlProperty(
    control_name="controlName",

    # the properties below are optional
    control_input_parameters=[backup.CfnFramework.ControlInputParameterProperty(
        parameter_name="parameterName",
        parameter_value="parameterValue"
    )],
    control_scope=control_scope
)
java
// 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;

FrameworkControlProperty frameworkControlProperty = FrameworkControlProperty.builder()
        .controlName("controlName")

        // the properties below are optional
        .controlInputParameters(List.of(ControlInputParameterProperty.builder()
                .parameterName("parameterName")
                .parameterValue("parameterValue")
                .build()))
        .controlScope(controlScope)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 frameworkControlProperty = new FrameworkControlProperty {
    ControlName = "controlName",

    // the properties below are optional
    ControlInputParameters = new [] { new ControlInputParameterProperty {
        ParameterName = "parameterName",
        ParameterValue = "parameterValue"
    } },
    ControlScope = controlScope
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var controlScope interface{}

frameworkControlProperty := &FrameworkControlProperty{
	ControlName: jsii.String("controlName"),

	// the properties below are optional
	ControlInputParameters: []interface{}{
		&ControlInputParameterProperty{
			ParameterName: jsii.String("parameterName"),
			ParameterValue: jsii.String("parameterValue"),
		},
	},
	ControlScope: controlScope,
}

Properties ​

controlInputParametersoptionalIResolvable | IResolvable | CfnFramework.ControlInputParameterProperty[]control_input_parametersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ControlInputParameterProperty]]]controlInputParametersoptionalIResolvableControlInputParametersoptionalIResolvableControlInputParametersoptionalinterface{}#
The name/value pairs.
controlNamestringcontrol_namestrcontrolNameStringControlNamestringControlName*stringrequired#
The name of a control.

This name is between 1 and 256 characters.

controlScopeoptionalanycontrol_scopeoptionalAnycontrolScopeoptionalObjectControlScopeoptionalobjectControlScopeoptionalinterface{}#
The scope of a control.
notes

The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.

For more information, see ControlScope .