Show / Hide Table of Contents

Class CfnBucket.DestinationProperty

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.

Inheritance
object
CfnBucket.DestinationProperty
Implements
CfnBucket.IDestinationProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBucket.DestinationProperty : CfnBucket.IDestinationProperty
Syntax (vb)
Public Class CfnBucket.DestinationProperty Implements CfnBucket.IDestinationProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3;

             var destinationProperty = new DestinationProperty {
                 BucketArn = "bucketArn",
                 Format = "format",

                 // the properties below are optional
                 BucketAccountId = "bucketAccountId",
                 Prefix = "prefix"
             };

Synopsis

Constructors

DestinationProperty()

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.

Properties

BucketAccountId

The account ID that owns the destination S3 bucket.

BucketArn

The Amazon Resource Name (ARN) of the bucket to which data is exported.

Format

Specifies the file format used when exporting data to Amazon S3.

Prefix

The prefix to use when exporting data.

Constructors

DestinationProperty()

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.

public DestinationProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3;

             var destinationProperty = new DestinationProperty {
                 BucketArn = "bucketArn",
                 Format = "format",

                 // the properties below are optional
                 BucketAccountId = "bucketAccountId",
                 Prefix = "prefix"
             };

Properties

BucketAccountId

The account ID that owns the destination S3 bucket.

public string? BucketAccountId { get; set; }
Property Value

string

Remarks

If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketaccountid

BucketArn

The Amazon Resource Name (ARN) of the bucket to which data is exported.

public string BucketArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketarn

Format

Specifies the file format used when exporting data to Amazon S3.

public string Format { get; set; }
Property Value

string

Remarks

Allowed values : CSV | ORC | Parquet

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-format

Prefix

The prefix to use when exporting data.

public string? Prefix { get; set; }
Property Value

string

Remarks

The prefix is prepended to all results.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-prefix

Implements

CfnBucket.IDestinationProperty
Back to top Generated by DocFX