1. Packages
  2. AWS Native
  3. API Docs
  4. backup
  5. BackupSelection

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.backup.BackupSelection

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Resource Type definition for AWS::Backup::BackupSelection

    Create BackupSelection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new BackupSelection(name: string, args: BackupSelectionArgs, opts?: CustomResourceOptions);
    @overload
    def BackupSelection(resource_name: str,
                        args: BackupSelectionArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def BackupSelection(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        backup_plan_id: Optional[str] = None,
                        backup_selection: Optional[BackupSelectionResourceTypeArgs] = None)
    func NewBackupSelection(ctx *Context, name string, args BackupSelectionArgs, opts ...ResourceOption) (*BackupSelection, error)
    public BackupSelection(string name, BackupSelectionArgs args, CustomResourceOptions? opts = null)
    public BackupSelection(String name, BackupSelectionArgs args)
    public BackupSelection(String name, BackupSelectionArgs args, CustomResourceOptions options)
    
    type: aws-native:backup:BackupSelection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BackupSelectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BackupSelectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BackupSelectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupSelectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupSelectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const backupSelectionResource = new aws_native.backup.BackupSelection("backupSelectionResource", {
        backupPlanId: "string",
        backupSelection: {
            iamRoleArn: "string",
            selectionName: "string",
            conditions: {
                stringEquals: [{
                    conditionKey: "string",
                    conditionValue: "string",
                }],
                stringLike: [{
                    conditionKey: "string",
                    conditionValue: "string",
                }],
                stringNotEquals: [{
                    conditionKey: "string",
                    conditionValue: "string",
                }],
                stringNotLike: [{
                    conditionKey: "string",
                    conditionValue: "string",
                }],
            },
            listOfTags: [{
                conditionKey: "string",
                conditionType: "string",
                conditionValue: "string",
            }],
            notResources: ["string"],
            resources: ["string"],
        },
    });
    
    Coming soon!
    

    BackupSelection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The BackupSelection resource accepts the following input properties:

    BackupPlanId string
    Uniquely identifies a backup plan.
    BackupSelectionValue Pulumi.AwsNative.Backup.Inputs.BackupSelectionResourceType

    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.

    BackupPlanId string
    Uniquely identifies a backup plan.
    BackupSelection BackupSelectionResourceTypeArgs

    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.

    backupPlanId String
    Uniquely identifies a backup plan.
    backupSelection BackupSelectionResourceType

    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.

    backupPlanId string
    Uniquely identifies a backup plan.
    backupSelection BackupSelectionResourceType

    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.

    backup_plan_id str
    Uniquely identifies a backup plan.
    backup_selection BackupSelectionResourceTypeArgs

    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.

    backupPlanId String
    Uniquely identifies a backup plan.
    backupSelection Property Map

    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BackupSelection resource produces the following output properties:

    AwsId string
    Uniquely identifies the backup selection.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelectionId string
    Uniquely identifies a request to assign a set of resources to a backup plan.
    AwsId string
    Uniquely identifies the backup selection.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelectionId string
    Uniquely identifies a request to assign a set of resources to a backup plan.
    awsId String
    Uniquely identifies the backup selection.
    id String
    The provider-assigned unique ID for this managed resource.
    selectionId String
    Uniquely identifies a request to assign a set of resources to a backup plan.
    awsId string
    Uniquely identifies the backup selection.
    id string
    The provider-assigned unique ID for this managed resource.
    selectionId string
    Uniquely identifies a request to assign a set of resources to a backup plan.
    aws_id str
    Uniquely identifies the backup selection.
    id str
    The provider-assigned unique ID for this managed resource.
    selection_id str
    Uniquely identifies a request to assign a set of resources to a backup plan.
    awsId String
    Uniquely identifies the backup selection.
    id String
    The provider-assigned unique ID for this managed resource.
    selectionId String
    Uniquely identifies a request to assign a set of resources to a backup plan.

    Supporting Types

    BackupSelectionConditionParameter, BackupSelectionConditionParameterArgs

    ConditionKey string
    The key in a key-value pair. For example, in the tag Department: Accounting , Department is the key.
    ConditionValue string
    The value in a key-value pair. For example, in the tag Department: Accounting , Accounting is the value.
    ConditionKey string
    The key in a key-value pair. For example, in the tag Department: Accounting , Department is the key.
    ConditionValue string
    The value in a key-value pair. For example, in the tag Department: Accounting , Accounting is the value.
    conditionKey String
    The key in a key-value pair. For example, in the tag Department: Accounting , Department is the key.
    conditionValue String
    The value in a key-value pair. For example, in the tag Department: Accounting , Accounting is the value.
    conditionKey string
    The key in a key-value pair. For example, in the tag Department: Accounting , Department is the key.
    conditionValue string
    The value in a key-value pair. For example, in the tag Department: Accounting , Accounting is the value.
    condition_key str
    The key in a key-value pair. For example, in the tag Department: Accounting , Department is the key.
    condition_value str
    The value in a key-value pair. For example, in the tag Department: Accounting , Accounting is the value.
    conditionKey String
    The key in a key-value pair. For example, in the tag Department: Accounting , Department is the key.
    conditionValue String
    The value in a key-value pair. For example, in the tag Department: Accounting , Accounting is the value.

    BackupSelectionConditionResourceType, BackupSelectionConditionResourceTypeArgs

    ConditionKey string
    The key in a key-value pair. For example, in "Department": "accounting" , "Department" is the key.
    ConditionType string
    An operation, such as STRINGEQUALS , that is applied to a key-value pair used to filter resources in a selection.
    ConditionValue string
    The value in a key-value pair. For example, in "Department": "accounting" , "accounting" is the value.
    ConditionKey string
    The key in a key-value pair. For example, in "Department": "accounting" , "Department" is the key.
    ConditionType string
    An operation, such as STRINGEQUALS , that is applied to a key-value pair used to filter resources in a selection.
    ConditionValue string
    The value in a key-value pair. For example, in "Department": "accounting" , "accounting" is the value.
    conditionKey String
    The key in a key-value pair. For example, in "Department": "accounting" , "Department" is the key.
    conditionType String
    An operation, such as STRINGEQUALS , that is applied to a key-value pair used to filter resources in a selection.
    conditionValue String
    The value in a key-value pair. For example, in "Department": "accounting" , "accounting" is the value.
    conditionKey string
    The key in a key-value pair. For example, in "Department": "accounting" , "Department" is the key.
    conditionType string
    An operation, such as STRINGEQUALS , that is applied to a key-value pair used to filter resources in a selection.
    conditionValue string
    The value in a key-value pair. For example, in "Department": "accounting" , "accounting" is the value.
    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.
    conditionKey String
    The key in a key-value pair. For example, in "Department": "accounting" , "Department" is the key.
    conditionType String
    An operation, such as STRINGEQUALS , that is applied to a key-value pair used to filter resources in a selection.
    conditionValue String
    The value in a key-value pair. For example, in "Department": "accounting" , "accounting" is the value.

    BackupSelectionResourceType, BackupSelectionResourceTypeArgs

    IamRoleArn string
    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 .
    SelectionName string
    The display name of a resource selection document.
    Conditions Pulumi.AwsNative.Backup.Inputs.BackupSelectionResourceTypeConditionsProperties

    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 .
    ListOfTags List<Pulumi.AwsNative.Backup.Inputs.BackupSelectionConditionResourceType>

    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 .
    NotResources List<string>

    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 List<string>
    An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
    IamRoleArn string
    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 .
    SelectionName string
    The display name of a resource selection document.
    Conditions BackupSelectionResourceTypeConditionsProperties

    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 .
    ListOfTags []BackupSelectionConditionResourceType

    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 .
    NotResources []string

    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 []string
    An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
    iamRoleArn String
    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 .
    selectionName String
    The display name of a resource selection document.
    conditions BackupSelectionResourceTypeConditionsProperties

    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 .
    listOfTags List<BackupSelectionConditionResourceType>

    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 .
    notResources List<String>

    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 List<String>
    An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
    iamRoleArn string
    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 .
    selectionName string
    The display name of a resource selection document.
    conditions BackupSelectionResourceTypeConditionsProperties

    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 .
    listOfTags BackupSelectionConditionResourceType[]

    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 .
    notResources string[]

    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 string[]
    An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
    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 BackupSelectionResourceTypeConditionsProperties

    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 Sequence[BackupSelectionConditionResourceType]

    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 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 Sequence[str]
    An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
    iamRoleArn String
    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 .
    selectionName String
    The display name of a resource selection document.
    conditions Property Map

    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 .
    listOfTags List<Property Map>

    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 .
    notResources List<String>

    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 List<String>
    An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.

    BackupSelectionResourceTypeConditionsProperties, BackupSelectionResourceTypeConditionsPropertiesArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi