S3 export/import description is off

[Doug-AWS]

As far as I can tell, S3 bucket.export returns a BucketRefProps object, not BucketRef. This works for me:

import cdk = require("@aws-cdk/cdk");
import s3 = require("@aws-cdk/aws-s3");

class HelloCdkStack extends cdk.Stack {
    public readonly myBucketRef: s3.BucketRefProps;

    constructor(parent: cdk.App, name: string, props?: cdk.StackProps) {
        super(parent, name, props);

        const mybucket = new s3.Bucket(this, "MyFirstBucket");

        this.myBucketRef = mybucket.export();
    }
}

interface ConsumerProps {
    userBucketRef: s3.BucketRefProps;
}

class MyCdkStack extends cdk.Stack {
    constructor(parent: cdk.App, name: string, props: ConsumerProps) {
        super(parent, name);

        s3.Bucket.import(this, "MyOtherBucket", props.userBucketRef);
    }
}

const app = new cdk.App(process.argv);

const myStack = new HelloCdkStack(app, "HelloCdkStack");
new MyCdkStack(app, "MyCdkStack", {
    userBucketRef: myStack.myBucketRef
});

process.stdout.write(app.run());

[Doug-AWS]

This is part of the general conversation about the change to the export/import model. See #1525

[Doug-AWS]

Is this code correct? I will not add this info to the guide until a CDK dev endorses it.

[rix0rrr]

This is not the recommended way of sharing buckets anymore.

• In-app, in-region/in-account bucket sharing: transparent, use the object directly
• In-app, cross-region OR cross-account bucket sharing: wait for a change from @skinny85.
• Cross-app bucket sharing: wait for AWSCL: External resource references #1546

[Doug-AWS]

Okay, I'll wait on #1546

[Doug-AWS]

Closing