Skip to content
v2.277.0

S3Property Struct ​

The S3 property type specifies information about the Amazon S3 bucket that contains the code to be committed to the new repository.

S3 is a property of the AWS::CodeStar::GitHubRepository resource.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codestar as codestar } from 'aws-cdk-lib';
const s3Property: codestar.CfnGitHubRepository.S3Property = {
  bucket: 'bucket',
  key: 'key',

  // the properties below are optional
  objectVersion: 'objectVersion',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codestar as codestar

s3_property = codestar.CfnGitHubRepository.S3Property(
    bucket="bucket",
    key="key",

    # the properties below are optional
    object_version="objectVersion"
)
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.codestar.*;

S3Property s3Property = S3Property.builder()
        .bucket("bucket")
        .key("key")

        // the properties below are optional
        .objectVersion("objectVersion")
        .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.Codestar;

var s3Property = new S3Property {
    Bucket = "bucket",
    Key = "key",

    // the properties below are optional
    ObjectVersion = "objectVersion"
};
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"

s3Property := &S3Property{
	Bucket: jsii.String("bucket"),
	Key: jsii.String("key"),

	// the properties below are optional
	ObjectVersion: jsii.String("objectVersion"),
}

Properties ​

bucketstringbucketstrbucketStringBucketstringBucket*string required #
The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.
keystringkeystrkeyStringKeystringKey*string required #
The S3 object key or file name for the ZIP file.
objectVersionoptionalstringobject_versionoptionalstrobjectVersionoptionalStringObjectVersionoptionalstringObjectVersionoptional*string #
The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.