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

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

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.backup.BackupVault

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    Resource Type definition for AWS::Backup::BackupVault

    Create BackupVault Resource

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

    Constructor syntax

    new BackupVault(name: string, args?: BackupVaultArgs, opts?: CustomResourceOptions);
    @overload
    def BackupVault(resource_name: str,
                    args: Optional[BackupVaultArgs] = None,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def BackupVault(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    access_policy: Optional[Any] = None,
                    backup_vault_name: Optional[str] = None,
                    backup_vault_tags: Optional[Mapping[str, str]] = None,
                    encryption_key_arn: Optional[str] = None,
                    lock_configuration: Optional[BackupVaultLockConfigurationTypeArgs] = None,
                    notifications: Optional[BackupVaultNotificationObjectTypeArgs] = None)
    func NewBackupVault(ctx *Context, name string, args *BackupVaultArgs, opts ...ResourceOption) (*BackupVault, error)
    public BackupVault(string name, BackupVaultArgs? args = null, CustomResourceOptions? opts = null)
    public BackupVault(String name, BackupVaultArgs args)
    public BackupVault(String name, BackupVaultArgs args, CustomResourceOptions options)
    
    type: aws-native:backup:BackupVault
    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 BackupVaultArgs
    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 BackupVaultArgs
    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 BackupVaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupVaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupVaultArgs
    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 backupVaultResource = new aws_native.backup.BackupVault("backupVaultResource", {
        accessPolicy: "any",
        backupVaultName: "string",
        backupVaultTags: {
            string: "string",
        },
        encryptionKeyArn: "string",
        lockConfiguration: {
            minRetentionDays: 0,
            changeableForDays: 0,
            maxRetentionDays: 0,
        },
        notifications: {
            backupVaultEvents: ["string"],
            snsTopicArn: "string",
        },
    });
    
    Coming soon!
    

    BackupVault 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 BackupVault resource accepts the following input properties:

    AccessPolicy interface{}
    Search the CloudFormation User Guide for AWS::Backup::BackupVault for more information about the expected schema for this property.
    BackupVaultName string
    BackupVaultTags map[string]string
    EncryptionKeyArn string
    LockConfiguration BackupVaultLockConfigurationTypeArgs
    Notifications BackupVaultNotificationObjectTypeArgs
    accessPolicy Object
    Search the CloudFormation User Guide for AWS::Backup::BackupVault for more information about the expected schema for this property.
    backupVaultName String
    backupVaultTags Map<String,String>
    encryptionKeyArn String
    lockConfiguration BackupVaultLockConfigurationType
    notifications BackupVaultNotificationObjectType
    accessPolicy any
    Search the CloudFormation User Guide for AWS::Backup::BackupVault for more information about the expected schema for this property.
    backupVaultName string
    backupVaultTags {[key: string]: string}
    encryptionKeyArn string
    lockConfiguration BackupVaultLockConfigurationType
    notifications BackupVaultNotificationObjectType
    access_policy Any
    Search the CloudFormation User Guide for AWS::Backup::BackupVault for more information about the expected schema for this property.
    backup_vault_name str
    backup_vault_tags Mapping[str, str]
    encryption_key_arn str
    lock_configuration BackupVaultLockConfigurationTypeArgs
    notifications BackupVaultNotificationObjectTypeArgs
    accessPolicy Any
    Search the CloudFormation User Guide for AWS::Backup::BackupVault for more information about the expected schema for this property.
    backupVaultName String
    backupVaultTags Map<String>
    encryptionKeyArn String
    lockConfiguration Property Map
    notifications Property Map

    Outputs

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

    BackupVaultArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    BackupVaultArn string
    Id string
    The provider-assigned unique ID for this managed resource.
    backupVaultArn String
    id String
    The provider-assigned unique ID for this managed resource.
    backupVaultArn string
    id string
    The provider-assigned unique ID for this managed resource.
    backup_vault_arn str
    id str
    The provider-assigned unique ID for this managed resource.
    backupVaultArn String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    BackupVaultLockConfigurationType, BackupVaultLockConfigurationTypeArgs

    BackupVaultNotificationObjectType, BackupVaultNotificationObjectTypeArgs

    BackupVaultEvents List<string>
    SnsTopicArn string
    backupVaultEvents List<String>
    snsTopicArn String
    backupVaultEvents List<String>
    snsTopicArn String

    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.101.0 published on Thursday, Apr 11, 2024 by Pulumi