CfnBackupSelection

class aws_cdk.aws_backup.CfnBackupSelection(scope, id, *, backup_plan_id, backup_selection)

Bases: CfnResource

Specifies a set of resources to assign to a backup plan.

For a sample AWS CloudFormation template, see the AWS Backup Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupselection.html
CloudformationResource:: AWS::Backup::BackupSelection
ExampleMetadata:: fixture=_generated

Example:

# 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

# conditions: Any

cfn_backup_selection = backup.CfnBackupSelection(self, "MyCfnBackupSelection",
    backup_plan_id="backupPlanId",
    backup_selection=backup.CfnBackupSelection.BackupSelectionResourceTypeProperty(
        iam_role_arn="iamRoleArn",
        selection_name="selectionName",

        # the properties below are optional
        conditions=conditions,
        list_of_tags=[backup.CfnBackupSelection.ConditionResourceTypeProperty(
            condition_key="conditionKey",
            condition_type="conditionType",
            condition_value="conditionValue"
        )],
        not_resources=["notResources"],
        resources=["resources"]
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
backup_plan_id (str) – Uniquely identifies a backup plan.
backup_selection (Union[IResolvable, BackupSelectionResourceTypeProperty, Dict[str, Any]]) – Specifies the body of a request to assign a set of resources to a backup plan. It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service the resource belongs to, and an optional array of tags used to identify a set of resources.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Backup::BackupSelection'

attr_backup_plan_id

Uniquely identifies a backup plan.

CloudformationAttribute:: BackupPlanId

attr_id

Uniquely identifies the backup selection.

CloudformationAttribute:: Id

attr_selection_id

Uniquely identifies a request to assign a set of resources to a backup plan.

CloudformationAttribute:: SelectionId

backup_plan_id: Uniquely identifies a backup plan.

backup_selection: Specifies the body of a request to assign a set of resources to a backup plan.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

BackupSelectionResourceTypeProperty

class CfnBackupSelection.BackupSelectionResourceTypeProperty(*, iam_role_arn, selection_name, conditions=None, list_of_tags=None, not_resources=None, resources=None)

Bases: object

Specifies an object containing properties used to assign a set of resources to a backup plan.

Parameters:

iam_role_arn (str) – The ARN of the IAM role that AWS Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access .
selection_name (str) – The display name of a resource selection document.
conditions (Optional[Any]) – A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" }, . Condition operators are case sensitive. Conditions differs from ListOfTags as follows: - When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic). - Conditions supports StringEquals , StringLike , StringNotEquals , and StringNotLike . ListOfTags only supports StringEquals .
list_of_tags (Union[IResolvable, Sequence[Union[IResolvable, ConditionResourceTypeProperty, Dict[str, Any]]], None]) – A list of conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" }, . Condition operators are case sensitive. ListOfTags differs from Conditions as follows: - When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic). - ListOfTags only supports StringEquals . Conditions supports StringEquals , StringLike , StringNotEquals , and StringNotLike .
not_resources (Optional[Sequence[str]]) – A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards. If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.
resources (Optional[Sequence[str]]) – An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html

ExampleMetadata:

fixture=_generated

Example:

# 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

# conditions: Any

backup_selection_resource_type_property = backup.CfnBackupSelection.BackupSelectionResourceTypeProperty(
    iam_role_arn="iamRoleArn",
    selection_name="selectionName",

    # the properties below are optional
    conditions=conditions,
    list_of_tags=[backup.CfnBackupSelection.ConditionResourceTypeProperty(
        condition_key="conditionKey",
        condition_type="conditionType",
        condition_value="conditionValue"
    )],
    not_resources=["notResources"],
    resources=["resources"]
)

Attributes

conditions

A list of conditions that you define to assign resources to your backup plans using tags.

For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" }, . Condition operators are case sensitive.

Conditions differs from ListOfTags as follows:

When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
Conditions supports StringEquals , StringLike , StringNotEquals , and StringNotLike . ListOfTags only supports StringEquals .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-conditions

iam_role_arn

The ARN of the IAM role that AWS Backup uses to authenticate when backing up the target resource;

for example, arn:aws:iam::123456789012:role/S3Access .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-iamrolearn

list_of_tags

A list of conditions that you define to assign resources to your backup plans using tags.

For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" }, . Condition operators are case sensitive.

ListOfTags differs from Conditions as follows:

When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
ListOfTags only supports StringEquals . Conditions supports StringEquals , StringLike , StringNotEquals , and StringNotLike .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-listoftags

not_resources

A list of Amazon Resource Names (ARNs) to exclude from a backup plan.

The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-notresources

resources

An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-resources

selection_name

The display name of a resource selection document.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-backupselectionresourcetype.html#cfn-backup-backupselection-backupselectionresourcetype-selectionname

ConditionParameterProperty

class CfnBackupSelection.ConditionParameterProperty(*, condition_key=None, condition_value=None)

Bases: object

Includes information about tags you define to assign tagged resources to a backup plan.

Parameters:

condition_key (Optional[str]) – The key in a key-value pair. For example, in the tag Department: Accounting , Department is the key.
condition_value (Optional[str]) – The value in a key-value pair. For example, in the tag Department: Accounting , Accounting is the value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html

ExampleMetadata:

fixture=_generated

Example:

# 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

condition_parameter_property = backup.CfnBackupSelection.ConditionParameterProperty(
    condition_key="conditionKey",
    condition_value="conditionValue"
)

Attributes

condition_key

The key in a key-value pair.

For example, in the tag Department: Accounting , Department is the key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html#cfn-backup-backupselection-conditionparameter-conditionkey

condition_value

The value in a key-value pair.

For example, in the tag Department: Accounting , Accounting is the value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionparameter.html#cfn-backup-backupselection-conditionparameter-conditionvalue

ConditionResourceTypeProperty

class CfnBackupSelection.ConditionResourceTypeProperty(*, condition_key, condition_type, condition_value)

Bases: object

Specifies an object that contains an array of triplets made up of a condition type (such as STRINGEQUALS ), a key, and a value.

Conditions are used to filter resources in a selection that is assigned to a backup plan.

Parameters:

condition_key (str) – The key in a key-value pair. For example, in "Department": "accounting" , "Department" is the key.
condition_type (str) – An operation, such as STRINGEQUALS , that is applied to a key-value pair used to filter resources in a selection.
condition_value (str) – The value in a key-value pair. For example, in "Department": "accounting" , "accounting" is the value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html

ExampleMetadata:

fixture=_generated

Example:

# 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

condition_resource_type_property = backup.CfnBackupSelection.ConditionResourceTypeProperty(
    condition_key="conditionKey",
    condition_type="conditionType",
    condition_value="conditionValue"
)

Attributes

condition_key

The key in a key-value pair.

For example, in "Department": "accounting" , "Department" is the key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html#cfn-backup-backupselection-conditionresourcetype-conditionkey

condition_type

An operation, such as STRINGEQUALS , that is applied to a key-value pair used to filter resources in a selection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html#cfn-backup-backupselection-conditionresourcetype-conditiontype

condition_value

The value in a key-value pair.

For example, in "Department": "accounting" , "accounting" is the value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditionresourcetype.html#cfn-backup-backupselection-conditionresourcetype-conditionvalue

ConditionsProperty

class CfnBackupSelection.ConditionsProperty(*, string_equals=None, string_like=None, string_not_equals=None, string_not_like=None)

Bases: object

Contains information about which resources to include or exclude from a backup plan using their tags.

Conditions are case sensitive.

Parameters:

string_equals (Union[IResolvable, Sequence[Union[IResolvable, ConditionParameterProperty, Dict[str, Any]]], None]) – Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called “exact matching.”
string_like (Union[IResolvable, Sequence[Union[IResolvable, ConditionParameterProperty, Dict[str, Any]]], None]) – Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, “prod*” or “rod” matches the tag value “production”.
string_not_equals (Union[IResolvable, Sequence[Union[IResolvable, ConditionParameterProperty, Dict[str, Any]]], None]) – Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called “negated matching.”
string_not_like (Union[IResolvable, Sequence[Union[IResolvable, ConditionParameterProperty, Dict[str, Any]]], None]) – Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html

ExampleMetadata:

fixture=_generated

Example:

# 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

conditions_property = backup.CfnBackupSelection.ConditionsProperty(
    string_equals=[backup.CfnBackupSelection.ConditionParameterProperty(
        condition_key="conditionKey",
        condition_value="conditionValue"
    )],
    string_like=[backup.CfnBackupSelection.ConditionParameterProperty(
        condition_key="conditionKey",
        condition_value="conditionValue"
    )],
    string_not_equals=[backup.CfnBackupSelection.ConditionParameterProperty(
        condition_key="conditionKey",
        condition_value="conditionValue"
    )],
    string_not_like=[backup.CfnBackupSelection.ConditionParameterProperty(
        condition_key="conditionKey",
        condition_value="conditionValue"
    )]
)

Attributes

string_equals

Filters the values of your tagged resources for only those resources that you tagged with the same value.

Also called “exact matching.”

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html#cfn-backup-backupselection-conditions-stringequals

string_like

Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string.

For example, “prod*” or “rod” matches the tag value “production”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html#cfn-backup-backupselection-conditions-stringlike

string_not_equals

Filters the values of your tagged resources for only those resources that you tagged that do not have the same value.

Also called “negated matching.”

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html#cfn-backup-backupselection-conditions-stringnotequals

string_not_like

Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupselection-conditions.html#cfn-backup-backupselection-conditions-stringnotlike