Skip to content
v2.276.0

CfnBackupAccessPointProps Struct Added in v2.276.0 ​

Properties for defining a CfnBackupAccessPoint.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_backup as backup } from 'aws-cdk-lib';

declare const accessPointPolicy: any;
const cfnBackupAccessPointProps: backup.CfnBackupAccessPointProps = {
  recoveryPointArn: 'recoveryPointArn',

  // the properties below are optional
  accessPointInTime: 'accessPointInTime',
  accessPointPolicy: accessPointPolicy,
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# 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

# access_point_policy: Any

cfn_backup_access_point_props = backup.CfnBackupAccessPointProps(
    recovery_point_arn="recoveryPointArn",

    # the properties below are optional
    access_point_in_time="accessPointInTime",
    access_point_policy=access_point_policy,
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.backup.*;

Object accessPointPolicy;

CfnBackupAccessPointProps cfnBackupAccessPointProps = CfnBackupAccessPointProps.builder()
        .recoveryPointArn("recoveryPointArn")

        // the properties below are optional
        .accessPointInTime("accessPointInTime")
        .accessPointPolicy(accessPointPolicy)
        .name("name")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Backup;

var accessPointPolicy;

var cfnBackupAccessPointProps = new CfnBackupAccessPointProps {
    RecoveryPointArn = "recoveryPointArn",

    // the properties below are optional
    AccessPointInTime = "accessPointInTime",
    AccessPointPolicy = accessPointPolicy,
    Name = "name",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var accessPointPolicy interface{}

cfnBackupAccessPointProps := &CfnBackupAccessPointProps{
	RecoveryPointArn: jsii.String("recoveryPointArn"),

	// the properties below are optional
	AccessPointInTime: jsii.String("accessPointInTime"),
	AccessPointPolicy: accessPointPolicy,
	Name: jsii.String("name"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

accessPointInTimeoptionalstringaccess_point_in_timeoptionalstraccessPointInTimeoptionalStringAccessPointInTimeoptionalstringAccessPointInTimeoptional*string#
For continuous (point-in-time) recovery points, the timestamp in ISO 8601 format (for example 2021-11-27T03:30:27Z) that determines the point-in-time view of the backup data.

The timestamp must be within the continuous backup's retention period at the time the access point is created. Do not specify this for snapshot recovery points. The service reports it back under AccessPointMetadata.

accessPointPolicyoptionalanyaccess_point_policyoptionalAnyaccessPointPolicyoptionalObjectAccessPointPolicyoptionalobjectAccessPointPolicyoptionalinterface{}#
An optional resource-based policy document, in JSON, to apply to the underlying Amazon S3 access point.
notes

The policy controls how backup data can be accessed through the access point. If you do not specify a policy, access is governed by the caller's IAM permissions. The serialized policy may not exceed 200000 characters. This value is not returned by the service and cannot be updated in place.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the backup access point.

This name is shared with the Amazon S3 access point namespace. It must be unique within your account and Region and cannot conflict with an existing Amazon S3 access point. If omitted, a name is generated.

recoveryPointArnstringrecovery_point_arnstrrecoveryPointArnStringRecoveryPointArnstringRecoveryPointArn*stringrequired#
The Amazon Resource Name (ARN) of the recovery point for which to create the backup access point.

The recovery point must be an Amazon S3 recovery point in the AVAILABLE, STOPPED, or COMPLETED state.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags to assign to the backup access point.