BackupVault L2 construct
A backup vault.
Example
const importedVault = backup.BackupVault.fromBackupVaultName(this, 'Vault', 'myVaultName');
const role = new iam.Role(this, 'Access Role', { assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com') });
importedVault.grant(role, 'backup:StartBackupJob');
imported_vault = backup.BackupVault.from_backup_vault_name(self, "Vault", "myVaultName")
role = iam.Role(self, "Access Role", assumed_by=iam.ServicePrincipal("lambda.amazonaws.com"))
imported_vault.grant(role, "backup:StartBackupJob")
IBackupVault importedVault = BackupVault.fromBackupVaultName(this, "Vault", "myVaultName");
Role role = Role.Builder.create(this, "Access Role").assumedBy(new ServicePrincipal("lambda.amazonaws.com")).build();
importedVault.grant(role, "backup:StartBackupJob");
// Install: dotnet add package Amazon.CDK.Lib
var importedVault = BackupVault.FromBackupVaultName(this, "Vault", "myVaultName");
var role = new Role(this, "Access Role", new RoleProps { AssumedBy = new ServicePrincipal("lambda.amazonaws.com") });
importedVault.Grant(role, "backup:StartBackupJob");
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
importedVault := backup.BackupVault_FromBackupVaultName(this, jsii.String("Vault"), jsii.String("myVaultName"))
role := iam.NewRole(this, jsii.String("Access Role"), &RoleProps{
AssumedBy: iam.NewServicePrincipal(jsii.String("lambda.amazonaws.com")),
})
importedVault.Grant(role, jsii.String("backup:StartBackupJob"))
Initializer
new BackupVault(scope: Construct, id: string, props?: BackupVaultProps)
BackupVault(scope: Construct, id: str, props: typing.Optional[BackupVaultProps] = None)
new BackupVault(Construct scope, String id, BackupVaultProps props)
new BackupVault(Construct scope, string id, BackupVaultProps? props = null)
NewBackupVault(Scope Construct, Id *string, Props BackupVaultProps)
Construct Props
accessPolicyoptionalPolicyDocumentaccess_policyoptionalPolicyDocumentaccessPolicyoptionalPolicyDocumentAccessPolicyoptionalPolicyDocumentAccessPolicyoptionalPolicyDocument#Default: access is not restricted
backupVaultNameoptionalstringbackup_vault_nameoptionalstrbackupVaultNameoptionalStringBackupVaultNameoptionalstringBackupVaultNameoptional*string#Default: A CDK generated name
Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
blockRecoveryPointDeletionoptionalbooleanblock_recovery_point_deletionoptionalboolblockRecoveryPointDeletionoptionalBooleanBlockRecoveryPointDeletionoptionalboolBlockRecoveryPointDeletionoptional*bool= false#encryptionKeyoptionalIKeyRefencryption_keyoptionalIKeyRefencryptionKeyoptionalIKeyRefEncryptionKeyoptionalIKeyRefEncryptionKeyoptionalIKeyRef#Default: an Amazon managed KMS key
lockConfigurationoptionalLockConfigurationlock_configurationoptionalLockConfigurationlockConfigurationoptionalLockConfigurationLockConfigurationoptionalLockConfigurationLockConfigurationoptionalLockConfiguration#Default: AWS Backup Vault Lock is disabled
notificationEventsoptionalBackupVaultEvents[]notification_eventsoptionaltyping.List[BackupVaultEvents]notificationEventsoptionalList<BackupVaultEvents>NotificationEventsoptionalBackupVaultEvents[]NotificationEventsoptional*[]BackupVaultEvents#Default: all vault events if notificationTopic is defined
notificationTopicoptionalITopicnotification_topicoptionalITopicnotificationTopicoptionalITopicNotificationTopicoptionalITopicNotificationTopicoptionalITopic#Default: no notifications
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.RETAIN#Note that removing a vault that contains recovery points will fail.
Properties
backupVaultArnstringbackup_vault_arnstrbackupVaultArnStringBackupVaultArnstringBackupVaultArn*string#backupVaultNamestringbackup_vault_namestrbackupVaultNameStringBackupVaultNamestringBackupVaultName*string#backupVaultRefBackupVaultReferencebackup_vault_refBackupVaultReferencebackupVaultRefBackupVaultReferenceBackupVaultRefBackupVaultReferenceBackupVaultRefBackupVaultReference#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#Methods
addToAccessPolicy(statement: PolicyStatement): voiddef add_to_access_policy(self, statement: PolicyStatement) -> Nonepublic void addToAccessPolicy(PolicyStatement statement)public void AddToAccessPolicy(PolicyStatement statement)func AddToAccessPolicy(Statement PolicyStatement)#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
blockRecoveryPointDeletion(): voiddef block_recovery_point_deletion(self, ) -> Nonepublic void blockRecoveryPointDeletion()public void BlockRecoveryPointDeletion()func BlockRecoveryPointDeletion()#fromBackupVaultArn(scope: Construct, id: string, backupVaultArn: string): IBackupVault@staticmethod def from_backup_vault_arn(scope: Construct, id: str, backup_vault_arn: str) -> IBackupVaultpublic static IBackupVault fromBackupVaultArn(Construct scope, String id, String backupVaultArn)public static IBackupVault FromBackupVaultArn(Construct scope, string id, string backupVaultArn)func FromBackupVaultArn(Scope Construct, Id *string, BackupVaultArn *string) IBackupVaultstatic#fromBackupVaultName(scope: Construct, id: string, backupVaultName: string): IBackupVault@staticmethod def from_backup_vault_name(scope: Construct, id: str, backup_vault_name: str) -> IBackupVaultpublic static IBackupVault fromBackupVaultName(Construct scope, String id, String backupVaultName)public static IBackupVault FromBackupVaultName(Construct scope, string id, string backupVaultName)func FromBackupVaultName(Scope Construct, Id *string, BackupVaultName *string) IBackupVaultstatic#grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#[disable-awslint:no-grants]
2 parameters
Parameters
granteegranteegranteegranteeGrantee— Principal to grant right to.actionsactionsactionsactionsActions— The actions to grant.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.