Package software.amazon.awscdk.services.backup

Interface CfnFrameworkProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFrameworkProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:57.541Z")
@Stability(Stable)
public interface CfnFrameworkProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFramework.

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;
 CfnFrameworkProps cfnFrameworkProps = CfnFrameworkProps.builder()
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFrameworkProps.Builder	A builder for CfnFrameworkProps
static final class	CfnFrameworkProps.Jsii$Proxy	An implementation for CfnFrameworkProps

Method Summary

Modifier and Type	Method	Description
static CfnFrameworkProps.Builder	builder()
Object	getFrameworkControls()	Contains detailed information about all of the controls of a framework.
default String	getFrameworkDescription()	An optional description of the framework with a maximum 1,024 characters.
default String	getFrameworkName()	The unique name of a framework.
default List<CfnTag>	getFrameworkTags()	The tags to assign to your framework.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFrameworkControls

@Stability(Stable)
@NotNull
Object getFrameworkControls()

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

Each framework must contain at least one control.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkcontrols

getFrameworkDescription

@Stability(Stable)
@Nullable
default String getFrameworkDescription()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkdescription

getFrameworkName

@Stability(Stable)
@Nullable
default 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 (_).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkname

getFrameworkTags

@Stability(Stable)
@Nullable
default List<CfnTag> getFrameworkTags()

The tags to assign to your framework.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworktags

builder

@Stability(Stable)
static CfnFrameworkProps.Builder builder()

Returns:

a CfnFrameworkProps.Builder of CfnFrameworkProps