awsbackup

package
v2.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 2, 2021 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BackupPlan_IsConstruct 

func BackupPlan_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func BackupPlan_IsResource 

func BackupPlan_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func BackupSelection_IsConstruct 

func BackupSelection_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func BackupSelection_IsResource 

func BackupSelection_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func BackupVault_IsConstruct 

func BackupVault_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func BackupVault_IsResource 

func BackupVault_IsResource(construct constructs.IConstruct) *bool

Check whether the given construct is a Resource.

func CfnBackupPlan_CFN_RESOURCE_TYPE_NAME 

func CfnBackupPlan_CFN_RESOURCE_TYPE_NAME() *string

func CfnBackupPlan_IsCfnElement 

func CfnBackupPlan_IsCfnElement(x interface{}) *bool

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.

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

func CfnBackupPlan_IsCfnResource 

func CfnBackupPlan_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnBackupPlan_IsConstruct 

func CfnBackupPlan_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnBackupSelection_CFN_RESOURCE_TYPE_NAME 

func CfnBackupSelection_CFN_RESOURCE_TYPE_NAME() *string

func CfnBackupSelection_IsCfnElement 

func CfnBackupSelection_IsCfnElement(x interface{}) *bool

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.

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

func CfnBackupSelection_IsCfnResource 

func CfnBackupSelection_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnBackupSelection_IsConstruct 

func CfnBackupSelection_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnBackupVault_CFN_RESOURCE_TYPE_NAME 

func CfnBackupVault_CFN_RESOURCE_TYPE_NAME() *string

func CfnBackupVault_IsCfnElement 

func CfnBackupVault_IsCfnElement(x interface{}) *bool

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.

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

func CfnBackupVault_IsCfnResource 

func CfnBackupVault_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnBackupVault_IsConstruct 

func CfnBackupVault_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnFramework_CFN_RESOURCE_TYPE_NAME 

func CfnFramework_CFN_RESOURCE_TYPE_NAME() *string

func CfnFramework_IsCfnElement 

func CfnFramework_IsCfnElement(x interface{}) *bool

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.

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

func CfnFramework_IsCfnResource 

func CfnFramework_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFramework_IsConstruct 

func CfnFramework_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnReportPlan_CFN_RESOURCE_TYPE_NAME 

func CfnReportPlan_CFN_RESOURCE_TYPE_NAME() *string

func CfnReportPlan_IsCfnElement 

func CfnReportPlan_IsCfnElement(x interface{}) *bool

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.

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

func CfnReportPlan_IsCfnResource 

func CfnReportPlan_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnReportPlan_IsConstruct 

func CfnReportPlan_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewBackupPlanRule_Override 

func NewBackupPlanRule_Override(b BackupPlanRule, props *BackupPlanRuleProps)

func NewBackupPlan_Override 

func NewBackupPlan_Override(b BackupPlan, scope constructs.Construct, id *string, props *BackupPlanProps)

func NewBackupResource_Override 

func NewBackupResource_Override(b BackupResource, resource *string, tagCondition *TagCondition, construct constructs.Construct)

func NewBackupSelection_Override 

func NewBackupSelection_Override(b BackupSelection, scope constructs.Construct, id *string, props *BackupSelectionProps)

func NewBackupVault_Override 

func NewBackupVault_Override(b BackupVault, scope constructs.Construct, id *string, props *BackupVaultProps)

func NewCfnBackupPlan_Override 

func NewCfnBackupPlan_Override(c CfnBackupPlan, scope constructs.Construct, id *string, props *CfnBackupPlanProps)

Create a new `AWS::Backup::BackupPlan`.

func NewCfnBackupSelection_Override 

func NewCfnBackupSelection_Override(c CfnBackupSelection, scope constructs.Construct, id *string, props *CfnBackupSelectionProps)

Create a new `AWS::Backup::BackupSelection`.

func NewCfnBackupVault_Override 

func NewCfnBackupVault_Override(c CfnBackupVault, scope constructs.Construct, id *string, props *CfnBackupVaultProps)

Create a new `AWS::Backup::BackupVault`.

func NewCfnFramework_Override 

func NewCfnFramework_Override(c CfnFramework, scope constructs.Construct, id *string, props *CfnFrameworkProps)

Create a new `AWS::Backup::Framework`.

func NewCfnReportPlan_Override 

func NewCfnReportPlan_Override(c CfnReportPlan, scope constructs.Construct, id *string, props *CfnReportPlanProps)

Create a new `AWS::Backup::ReportPlan`.

Types

type BackupPlan 

type BackupPlan interface {
	awscdk.Resource
	IBackupPlan
	BackupPlanArn() *string
	BackupPlanId() *string
	BackupVault() IBackupVault
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	VersionId() *string
	AddRule(rule BackupPlanRule)
	AddSelection(id *string, options *BackupSelectionOptions) BackupSelection
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

A backup plan.

TODO: EXAMPLE

func BackupPlan_Daily35DayRetention 

func BackupPlan_Daily35DayRetention(scope constructs.Construct, id *string, backupVault IBackupVault) BackupPlan

Daily with 35 day retention.

func BackupPlan_DailyMonthly1YearRetention 

func BackupPlan_DailyMonthly1YearRetention(scope constructs.Construct, id *string, backupVault IBackupVault) BackupPlan

Daily and monthly with 1 year retention.

func BackupPlan_DailyWeeklyMonthly5YearRetention 

func BackupPlan_DailyWeeklyMonthly5YearRetention(scope constructs.Construct, id *string, backupVault IBackupVault) BackupPlan

Daily, weekly and monthly with 5 year retention.

func BackupPlan_DailyWeeklyMonthly7YearRetention 

func BackupPlan_DailyWeeklyMonthly7YearRetention(scope constructs.Construct, id *string, backupVault IBackupVault) BackupPlan

Daily, weekly and monthly with 7 year retention.

func NewBackupPlan 

func NewBackupPlan(scope constructs.Construct, id *string, props *BackupPlanProps) BackupPlan

type BackupPlanProps 

type BackupPlanProps struct {
	// The display name of the backup plan.
	BackupPlanName *string `json:"backupPlanName"`
	// Rules for the backup plan.
	//
	// Use `addRule()` to add rules after
	// instantiation.
	BackupPlanRules *[]BackupPlanRule `json:"backupPlanRules"`
	// The backup vault where backups are stored.
	BackupVault IBackupVault `json:"backupVault"`
}

Properties for a BackupPlan.

TODO: EXAMPLE

type BackupPlanRule 

type BackupPlanRule interface {
	Props() *BackupPlanRuleProps
}

A backup plan rule.

TODO: EXAMPLE

func BackupPlanRule_Daily 

func BackupPlanRule_Daily(backupVault IBackupVault) BackupPlanRule

Daily with 35 days retention.

func BackupPlanRule_Monthly1Year 

func BackupPlanRule_Monthly1Year(backupVault IBackupVault) BackupPlanRule

Monthly 1 year retention, move to cold storage after 1 month.

func BackupPlanRule_Monthly5Year 

func BackupPlanRule_Monthly5Year(backupVault IBackupVault) BackupPlanRule

Monthly 5 year retention, move to cold storage after 3 months.

func BackupPlanRule_Monthly7Year 

func BackupPlanRule_Monthly7Year(backupVault IBackupVault) BackupPlanRule

Monthly 7 year retention, move to cold storage after 3 months.

func BackupPlanRule_Weekly 

func BackupPlanRule_Weekly(backupVault IBackupVault) BackupPlanRule

Weekly with 3 months retention.

func NewBackupPlanRule 

func NewBackupPlanRule(props *BackupPlanRuleProps) BackupPlanRule

type BackupPlanRuleProps 

type BackupPlanRuleProps struct {
	// The backup vault where backups are.
	BackupVault IBackupVault `json:"backupVault"`
	// The duration after a backup job is successfully started before it must be completed or it is canceled by AWS Backup.
	CompletionWindow awscdk.Duration `json:"completionWindow"`
	// Specifies the duration after creation that a recovery point is deleted.
	//
	// Must be greater than `moveToColdStorageAfter`.
	DeleteAfter awscdk.Duration `json:"deleteAfter"`
	// Specifies the duration after creation that a recovery point is moved to cold storage.
	MoveToColdStorageAfter awscdk.Duration `json:"moveToColdStorageAfter"`
	// A display name for the backup rule.
	RuleName *string `json:"ruleName"`
	// A CRON expression specifying when AWS Backup initiates a backup job.
	ScheduleExpression awsevents.Schedule `json:"scheduleExpression"`
	// The duration after a backup is scheduled before a job is canceled if it doesn't start successfully.
	StartWindow awscdk.Duration `json:"startWindow"`
}

Properties for a BackupPlanRule.

TODO: EXAMPLE

type BackupResource 

type BackupResource interface {
	Construct() constructs.Construct
	Resource() *string
	TagCondition() *TagCondition
}

A resource to backup.

TODO: EXAMPLE

func BackupResource_FromArn 

func BackupResource_FromArn(arn *string) BackupResource

A list of ARNs or match patterns such as `arn:aws:ec2:us-east-1:123456789012:volume/*`.

func BackupResource_FromConstruct 

func BackupResource_FromConstruct(construct constructs.Construct) BackupResource

Adds all supported resources in a construct.

func BackupResource_FromDynamoDbTable 

func BackupResource_FromDynamoDbTable(table awsdynamodb.ITable) BackupResource

A DynamoDB table.

func BackupResource_FromEc2Instance 

func BackupResource_FromEc2Instance(instance awsec2.IInstance) BackupResource

An EC2 instance.

func BackupResource_FromEfsFileSystem 

func BackupResource_FromEfsFileSystem(fileSystem awsefs.IFileSystem) BackupResource

An EFS file system.

func BackupResource_FromRdsDatabaseInstance 

func BackupResource_FromRdsDatabaseInstance(instance awsrds.IDatabaseInstance) BackupResource

A RDS database instance.

func BackupResource_FromTag 

func BackupResource_FromTag(key *string, value *string, operation TagOperation) BackupResource

A tag condition.

func NewBackupResource 

func NewBackupResource(resource *string, tagCondition *TagCondition, construct constructs.Construct) BackupResource

type BackupSelection 

type BackupSelection interface {
	awscdk.Resource
	awsiam.IGrantable
	BackupPlanId() *string
	Env() *awscdk.ResourceEnvironment
	GrantPrincipal() awsiam.IPrincipal
	Node() constructs.Node
	PhysicalName() *string
	SelectionId() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	ToString() *string
}

A backup selection.

TODO: EXAMPLE

func NewBackupSelection 

func NewBackupSelection(scope constructs.Construct, id *string, props *BackupSelectionProps) BackupSelection

type BackupSelectionOptions 

type BackupSelectionOptions struct {
	// Whether to automatically give restores permissions to the role that AWS Backup uses.
	//
	// If `true`, the `AWSBackupServiceRolePolicyForRestores` managed
	// policy will be attached to the role.
	AllowRestores *bool `json:"allowRestores"`
	// The name for this selection.
	BackupSelectionName *string `json:"backupSelectionName"`
	// The resources to backup.
	//
	// Use the helper static methods defined on `BackupResource`.
	Resources *[]BackupResource `json:"resources"`
	// The role that AWS Backup uses to authenticate when backuping or restoring the resources.
	//
	// The `AWSBackupServiceRolePolicyForBackup` managed policy
	// will be attached to this role.
	Role awsiam.IRole `json:"role"`
}

Options for a BackupSelection.

TODO: EXAMPLE

type BackupSelectionProps 

type BackupSelectionProps struct {
	// Whether to automatically give restores permissions to the role that AWS Backup uses.
	//
	// If `true`, the `AWSBackupServiceRolePolicyForRestores` managed
	// policy will be attached to the role.
	AllowRestores *bool `json:"allowRestores"`
	// The name for this selection.
	BackupSelectionName *string `json:"backupSelectionName"`
	// The resources to backup.
	//
	// Use the helper static methods defined on `BackupResource`.
	Resources *[]BackupResource `json:"resources"`
	// The role that AWS Backup uses to authenticate when backuping or restoring the resources.
	//
	// The `AWSBackupServiceRolePolicyForBackup` managed policy
	// will be attached to this role.
	Role awsiam.IRole `json:"role"`
	// The backup plan for this selection.
	BackupPlan IBackupPlan `json:"backupPlan"`
}

Properties for a BackupSelection.

TODO: EXAMPLE

type BackupVault 

type BackupVault interface {
	awscdk.Resource
	IBackupVault
	BackupVaultArn() *string
	BackupVaultName() *string
	Env() *awscdk.ResourceEnvironment
	Node() constructs.Node
	PhysicalName() *string
	Stack() awscdk.Stack
	AddToAccessPolicy(statement awsiam.PolicyStatement)
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	BlockRecoveryPointDeletion()
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	Grant(grantee awsiam.IGrantable, actions ...*string) awsiam.Grant
	ToString() *string
}

A backup vault.

TODO: EXAMPLE

func NewBackupVault 

func NewBackupVault(scope constructs.Construct, id *string, props *BackupVaultProps) BackupVault

type BackupVaultEvents 

type BackupVaultEvents string

Backup vault events. 

const (
	BackupVaultEvents_BACKUP_JOB_STARTED      BackupVaultEvents = "BACKUP_JOB_STARTED"
	BackupVaultEvents_BACKUP_JOB_COMPLETED    BackupVaultEvents = "BACKUP_JOB_COMPLETED"
	BackupVaultEvents_BACKUP_JOB_SUCCESSFUL   BackupVaultEvents = "BACKUP_JOB_SUCCESSFUL"
	BackupVaultEvents_BACKUP_JOB_FAILED       BackupVaultEvents = "BACKUP_JOB_FAILED"
	BackupVaultEvents_BACKUP_JOB_EXPIRED      BackupVaultEvents = "BACKUP_JOB_EXPIRED"
	BackupVaultEvents_RESTORE_JOB_STARTED     BackupVaultEvents = "RESTORE_JOB_STARTED"
	BackupVaultEvents_RESTORE_JOB_COMPLETED   BackupVaultEvents = "RESTORE_JOB_COMPLETED"
	BackupVaultEvents_RESTORE_JOB_SUCCESSFUL  BackupVaultEvents = "RESTORE_JOB_SUCCESSFUL"
	BackupVaultEvents_RESTORE_JOB_FAILED      BackupVaultEvents = "RESTORE_JOB_FAILED"
	BackupVaultEvents_COPY_JOB_STARTED        BackupVaultEvents = "COPY_JOB_STARTED"
	BackupVaultEvents_COPY_JOB_SUCCESSFUL     BackupVaultEvents = "COPY_JOB_SUCCESSFUL"
	BackupVaultEvents_COPY_JOB_FAILED         BackupVaultEvents = "COPY_JOB_FAILED"
	BackupVaultEvents_RECOVERY_POINT_MODIFIED BackupVaultEvents = "RECOVERY_POINT_MODIFIED"
	BackupVaultEvents_BACKUP_PLAN_CREATED     BackupVaultEvents = "BACKUP_PLAN_CREATED"
	BackupVaultEvents_BACKUP_PLAN_MODIFIED    BackupVaultEvents = "BACKUP_PLAN_MODIFIED"
)

type BackupVaultProps 

type BackupVaultProps struct {
	// A resource-based policy that is used to manage access permissions on the backup vault.
	AccessPolicy awsiam.PolicyDocument `json:"accessPolicy"`
	// The name of a logical container where backups are stored.
	//
	// Backup vaults
	// are identified by names that are unique to the account used to create
	// them and the AWS Region where they are created.
	BackupVaultName *string `json:"backupVaultName"`
	// Whether to add statements to the vault access policy that prevents anyone from deleting a recovery point.
	BlockRecoveryPointDeletion *bool `json:"blockRecoveryPointDeletion"`
	// The server-side encryption key to use to protect your backups.
	EncryptionKey awskms.IKey `json:"encryptionKey"`
	// The vault events to send.
	// See: https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html
	//
	NotificationEvents *[]BackupVaultEvents `json:"notificationEvents"`
	// A SNS topic to send vault events to.
	// See: https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html
	//
	NotificationTopic awssns.ITopic `json:"notificationTopic"`
	// The removal policy to apply to the vault.
	//
	// Note that removing a vault
	// that contains recovery points will fail.
	RemovalPolicy awscdk.RemovalPolicy `json:"removalPolicy"`
}

Properties for a BackupVault.

TODO: EXAMPLE

type CfnBackupPlan 

type CfnBackupPlan interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrBackupPlanArn() *string
	AttrBackupPlanId() *string
	AttrVersionId() *string
	BackupPlan() interface{}
	SetBackupPlan(val interface{})
	BackupPlanTags() interface{}
	SetBackupPlanTags(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Backup::BackupPlan`.

TODO: EXAMPLE

func NewCfnBackupPlan 

func NewCfnBackupPlan(scope constructs.Construct, id *string, props *CfnBackupPlanProps) CfnBackupPlan

Create a new `AWS::Backup::BackupPlan`.

type CfnBackupPlanProps 

type CfnBackupPlanProps struct {
	// `AWS::Backup::BackupPlan.BackupPlan`.
	BackupPlan interface{} `json:"backupPlan"`
	// `AWS::Backup::BackupPlan.BackupPlanTags`.
	BackupPlanTags interface{} `json:"backupPlanTags"`
}

Properties for defining a `AWS::Backup::BackupPlan`.

TODO: EXAMPLE

type CfnBackupPlan_AdvancedBackupSettingResourceTypeProperty 

type CfnBackupPlan_AdvancedBackupSettingResourceTypeProperty struct {
	// `CfnBackupPlan.AdvancedBackupSettingResourceTypeProperty.BackupOptions`.
	BackupOptions interface{} `json:"backupOptions"`
	// `CfnBackupPlan.AdvancedBackupSettingResourceTypeProperty.ResourceType`.
	ResourceType *string `json:"resourceType"`
}

TODO: EXAMPLE

type CfnBackupPlan_BackupPlanResourceTypeProperty 

type CfnBackupPlan_BackupPlanResourceTypeProperty struct {
	// `CfnBackupPlan.BackupPlanResourceTypeProperty.AdvancedBackupSettings`.
	AdvancedBackupSettings interface{} `json:"advancedBackupSettings"`
	// `CfnBackupPlan.BackupPlanResourceTypeProperty.BackupPlanName`.
	BackupPlanName *string `json:"backupPlanName"`
	// `CfnBackupPlan.BackupPlanResourceTypeProperty.BackupPlanRule`.
	BackupPlanRule interface{} `json:"backupPlanRule"`
}

TODO: EXAMPLE

type CfnBackupPlan_BackupRuleResourceTypeProperty 

type CfnBackupPlan_BackupRuleResourceTypeProperty struct {
	// `CfnBackupPlan.BackupRuleResourceTypeProperty.CompletionWindowMinutes`.
	CompletionWindowMinutes *float64 `json:"completionWindowMinutes"`
	// `CfnBackupPlan.BackupRuleResourceTypeProperty.CopyActions`.
	CopyActions interface{} `json:"copyActions"`
	// `CfnBackupPlan.BackupRuleResourceTypeProperty.EnableContinuousBackup`.
	EnableContinuousBackup interface{} `json:"enableContinuousBackup"`
	// `CfnBackupPlan.BackupRuleResourceTypeProperty.Lifecycle`.
	Lifecycle interface{} `json:"lifecycle"`
	// `CfnBackupPlan.BackupRuleResourceTypeProperty.RecoveryPointTags`.
	RecoveryPointTags interface{} `json:"recoveryPointTags"`
	// `CfnBackupPlan.BackupRuleResourceTypeProperty.RuleName`.
	RuleName *string `json:"ruleName"`
	// `CfnBackupPlan.BackupRuleResourceTypeProperty.ScheduleExpression`.
	ScheduleExpression *string `json:"scheduleExpression"`
	// `CfnBackupPlan.BackupRuleResourceTypeProperty.StartWindowMinutes`.
	StartWindowMinutes *float64 `json:"startWindowMinutes"`
	// `CfnBackupPlan.BackupRuleResourceTypeProperty.TargetBackupVault`.
	TargetBackupVault *string `json:"targetBackupVault"`
}

TODO: EXAMPLE

type CfnBackupPlan_CopyActionResourceTypeProperty 

type CfnBackupPlan_CopyActionResourceTypeProperty struct {
	// `CfnBackupPlan.CopyActionResourceTypeProperty.DestinationBackupVaultArn`.
	DestinationBackupVaultArn *string `json:"destinationBackupVaultArn"`
	// `CfnBackupPlan.CopyActionResourceTypeProperty.Lifecycle`.
	Lifecycle interface{} `json:"lifecycle"`
}

TODO: EXAMPLE

type CfnBackupPlan_LifecycleResourceTypeProperty 

type CfnBackupPlan_LifecycleResourceTypeProperty struct {
	// `CfnBackupPlan.LifecycleResourceTypeProperty.DeleteAfterDays`.
	DeleteAfterDays *float64 `json:"deleteAfterDays"`
	// `CfnBackupPlan.LifecycleResourceTypeProperty.MoveToColdStorageAfterDays`.
	MoveToColdStorageAfterDays *float64 `json:"moveToColdStorageAfterDays"`
}

TODO: EXAMPLE

type CfnBackupSelection 

type CfnBackupSelection interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrBackupPlanId() *string
	AttrId() *string
	AttrSelectionId() *string
	BackupPlanId() *string
	SetBackupPlanId(val *string)
	BackupSelection() interface{}
	SetBackupSelection(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Backup::BackupSelection`.

TODO: EXAMPLE

func NewCfnBackupSelection 

func NewCfnBackupSelection(scope constructs.Construct, id *string, props *CfnBackupSelectionProps) CfnBackupSelection

Create a new `AWS::Backup::BackupSelection`.

type CfnBackupSelectionProps 

type CfnBackupSelectionProps struct {
	// `AWS::Backup::BackupSelection.BackupPlanId`.
	BackupPlanId *string `json:"backupPlanId"`
	// `AWS::Backup::BackupSelection.BackupSelection`.
	BackupSelection interface{} `json:"backupSelection"`
}

Properties for defining a `AWS::Backup::BackupSelection`.

TODO: EXAMPLE

type CfnBackupSelection_BackupSelectionResourceTypeProperty 

type CfnBackupSelection_BackupSelectionResourceTypeProperty struct {
	// `CfnBackupSelection.BackupSelectionResourceTypeProperty.Conditions`.
	Conditions interface{} `json:"conditions"`
	// `CfnBackupSelection.BackupSelectionResourceTypeProperty.IamRoleArn`.
	IamRoleArn *string `json:"iamRoleArn"`
	// `CfnBackupSelection.BackupSelectionResourceTypeProperty.ListOfTags`.
	ListOfTags interface{} `json:"listOfTags"`
	// `CfnBackupSelection.BackupSelectionResourceTypeProperty.NotResources`.
	NotResources *[]*string `json:"notResources"`
	// `CfnBackupSelection.BackupSelectionResourceTypeProperty.Resources`.
	Resources *[]*string `json:"resources"`
	// `CfnBackupSelection.BackupSelectionResourceTypeProperty.SelectionName`.
	SelectionName *string `json:"selectionName"`
}

TODO: EXAMPLE

type CfnBackupSelection_ConditionResourceTypeProperty 

type CfnBackupSelection_ConditionResourceTypeProperty struct {
	// `CfnBackupSelection.ConditionResourceTypeProperty.ConditionKey`.
	ConditionKey *string `json:"conditionKey"`
	// `CfnBackupSelection.ConditionResourceTypeProperty.ConditionType`.
	ConditionType *string `json:"conditionType"`
	// `CfnBackupSelection.ConditionResourceTypeProperty.ConditionValue`.
	ConditionValue *string `json:"conditionValue"`
}

TODO: EXAMPLE

type CfnBackupVault 

type CfnBackupVault interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AccessPolicy() interface{}
	SetAccessPolicy(val interface{})
	AttrBackupVaultArn() *string
	AttrBackupVaultName() *string
	BackupVaultName() *string
	SetBackupVaultName(val *string)
	BackupVaultTags() interface{}
	SetBackupVaultTags(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	EncryptionKeyArn() *string
	SetEncryptionKeyArn(val *string)
	LockConfiguration() interface{}
	SetLockConfiguration(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Notifications() interface{}
	SetNotifications(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Backup::BackupVault`.

TODO: EXAMPLE

func NewCfnBackupVault 

func NewCfnBackupVault(scope constructs.Construct, id *string, props *CfnBackupVaultProps) CfnBackupVault

Create a new `AWS::Backup::BackupVault`.

type CfnBackupVaultProps 

type CfnBackupVaultProps struct {
	// `AWS::Backup::BackupVault.AccessPolicy`.
	AccessPolicy interface{} `json:"accessPolicy"`
	// `AWS::Backup::BackupVault.BackupVaultName`.
	BackupVaultName *string `json:"backupVaultName"`
	// `AWS::Backup::BackupVault.BackupVaultTags`.
	BackupVaultTags interface{} `json:"backupVaultTags"`
	// `AWS::Backup::BackupVault.EncryptionKeyArn`.
	EncryptionKeyArn *string `json:"encryptionKeyArn"`
	// `AWS::Backup::BackupVault.LockConfiguration`.
	LockConfiguration interface{} `json:"lockConfiguration"`
	// `AWS::Backup::BackupVault.Notifications`.
	Notifications interface{} `json:"notifications"`
}

Properties for defining a `AWS::Backup::BackupVault`.

TODO: EXAMPLE

type CfnBackupVault_LockConfigurationTypeProperty 

type CfnBackupVault_LockConfigurationTypeProperty struct {
	// `CfnBackupVault.LockConfigurationTypeProperty.ChangeableForDays`.
	ChangeableForDays *float64 `json:"changeableForDays"`
	// `CfnBackupVault.LockConfigurationTypeProperty.MaxRetentionDays`.
	MaxRetentionDays *float64 `json:"maxRetentionDays"`
	// `CfnBackupVault.LockConfigurationTypeProperty.MinRetentionDays`.
	MinRetentionDays *float64 `json:"minRetentionDays"`
}

TODO: EXAMPLE

type CfnBackupVault_NotificationObjectTypeProperty 

type CfnBackupVault_NotificationObjectTypeProperty struct {
	// `CfnBackupVault.NotificationObjectTypeProperty.BackupVaultEvents`.
	BackupVaultEvents *[]*string `json:"backupVaultEvents"`
	// `CfnBackupVault.NotificationObjectTypeProperty.SNSTopicArn`.
	SnsTopicArn *string `json:"snsTopicArn"`
}

TODO: EXAMPLE

type CfnFramework 

type CfnFramework interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrCreationTime() awscdk.IResolvable
	AttrDeploymentStatus() *string
	AttrFrameworkArn() *string
	AttrFrameworkStatus() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	FrameworkControls() interface{}
	SetFrameworkControls(val interface{})
	FrameworkDescription() *string
	SetFrameworkDescription(val *string)
	FrameworkName() *string
	SetFrameworkName(val *string)
	FrameworkTags() interface{}
	SetFrameworkTags(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Backup::Framework`.

TODO: EXAMPLE

func NewCfnFramework 

func NewCfnFramework(scope constructs.Construct, id *string, props *CfnFrameworkProps) CfnFramework

Create a new `AWS::Backup::Framework`.

type CfnFrameworkProps 

type CfnFrameworkProps struct {
	// `AWS::Backup::Framework.FrameworkControls`.
	FrameworkControls interface{} `json:"frameworkControls"`
	// `AWS::Backup::Framework.FrameworkDescription`.
	FrameworkDescription *string `json:"frameworkDescription"`
	// `AWS::Backup::Framework.FrameworkName`.
	FrameworkName *string `json:"frameworkName"`
	// `AWS::Backup::Framework.FrameworkTags`.
	FrameworkTags interface{} `json:"frameworkTags"`
}

Properties for defining a `AWS::Backup::Framework`.

TODO: EXAMPLE

type CfnFramework_ControlInputParameterProperty 

type CfnFramework_ControlInputParameterProperty struct {
	// `CfnFramework.ControlInputParameterProperty.ParameterName`.
	ParameterName *string `json:"parameterName"`
	// `CfnFramework.ControlInputParameterProperty.ParameterValue`.
	ParameterValue *string `json:"parameterValue"`
}

TODO: EXAMPLE

type CfnFramework_FrameworkControlProperty 

type CfnFramework_FrameworkControlProperty struct {
	// `CfnFramework.FrameworkControlProperty.ControlInputParameters`.
	ControlInputParameters interface{} `json:"controlInputParameters"`
	// `CfnFramework.FrameworkControlProperty.ControlName`.
	ControlName *string `json:"controlName"`
	// `CfnFramework.FrameworkControlProperty.ControlScope`.
	ControlScope interface{} `json:"controlScope"`
}

TODO: EXAMPLE

type CfnReportPlan 

type CfnReportPlan interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrReportPlanArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	ReportDeliveryChannel() interface{}
	SetReportDeliveryChannel(val interface{})
	ReportPlanDescription() *string
	SetReportPlanDescription(val *string)
	ReportPlanName() *string
	SetReportPlanName(val *string)
	ReportPlanTags() interface{}
	SetReportPlanTags(val interface{})
	ReportSetting() interface{}
	SetReportSetting(val interface{})
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Backup::ReportPlan`.

TODO: EXAMPLE

func NewCfnReportPlan 

func NewCfnReportPlan(scope constructs.Construct, id *string, props *CfnReportPlanProps) CfnReportPlan

Create a new `AWS::Backup::ReportPlan`.

type CfnReportPlanProps 

type CfnReportPlanProps struct {
	// `AWS::Backup::ReportPlan.ReportDeliveryChannel`.
	ReportDeliveryChannel interface{} `json:"reportDeliveryChannel"`
	// `AWS::Backup::ReportPlan.ReportPlanDescription`.
	ReportPlanDescription *string `json:"reportPlanDescription"`
	// `AWS::Backup::ReportPlan.ReportPlanName`.
	ReportPlanName *string `json:"reportPlanName"`
	// `AWS::Backup::ReportPlan.ReportPlanTags`.
	ReportPlanTags interface{} `json:"reportPlanTags"`
	// `AWS::Backup::ReportPlan.ReportSetting`.
	ReportSetting interface{} `json:"reportSetting"`
}

Properties for defining a `AWS::Backup::ReportPlan`.

TODO: EXAMPLE

type IBackupPlan 

type IBackupPlan interface {
	awscdk.IResource
	// The identifier of the backup plan.
	BackupPlanId() *string
}

A backup plan.

func BackupPlan_FromBackupPlanId 

func BackupPlan_FromBackupPlanId(scope constructs.Construct, id *string, backupPlanId *string) IBackupPlan

Import an existing backup plan.

type IBackupVault 

type IBackupVault interface {
	awscdk.IResource
	// Grant the actions defined in actions to the given grantee on this backup vault.
	Grant(grantee awsiam.IGrantable, actions ...*string) awsiam.Grant
	// The ARN of the backup vault.
	BackupVaultArn() *string
	// The name of a logical container where backups are stored.
	BackupVaultName() *string
}

A backup vault.

func BackupVault_FromBackupVaultArn 

func BackupVault_FromBackupVaultArn(scope constructs.Construct, id *string, backupVaultArn *string) IBackupVault

Import an existing backup vault by arn.

func BackupVault_FromBackupVaultName 

func BackupVault_FromBackupVaultName(scope constructs.Construct, id *string, backupVaultName *string) IBackupVault

Import an existing backup vault by name.

type TagCondition 

type TagCondition struct {
	// The key in a key-value pair.
	//
	// For example, in `"ec2:ResourceTag/Department": "accounting"`,
	// `ec2:ResourceTag/Department` is the key.
	Key *string `json:"key"`
	// An operation that is applied to a key-value pair used to filter resources in a selection.
	Operation TagOperation `json:"operation"`
	// The value in a key-value pair.
	//
	// For example, in `"ec2:ResourceTag/Department": "accounting"`,
	// `accounting` is the value.
	Value *string `json:"value"`
}

A tag condition.

TODO: EXAMPLE

type TagOperation 

type TagOperation string

An operation that is applied to a key-value pair. 

const (
	TagOperation_DUMMY         TagOperation = "DUMMY"
	TagOperation_STRING_EQUALS TagOperation = "STRING_EQUALS"
)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.