aws-cdk-lib.aws_codestar.CfnGitHubRepository.S3Property

interface S3Property

LanguageType name
.NETAmazon.CDK.AWS.Codestar.CfnGitHubRepository.S3Property
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodestar#CfnGitHubRepository_S3Property
Javasoftware.amazon.awscdk.services.codestar.CfnGitHubRepository.S3Property
Pythonaws_cdk.aws_codestar.CfnGitHubRepository.S3Property
TypeScript aws-cdk-lib » aws_codestar » CfnGitHubRepository » S3Property

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

// 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',
};

Properties

NameTypeDescription
bucketstringThe name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.
keystringThe S3 object key or file name for the ZIP file.
objectVersion?stringThe object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.

bucket

Type: string

The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.


key

Type: string

The S3 object key or file name for the ZIP file.


objectVersion?

Type: string (optional)

The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.