class CfnGitHubRepositoryPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CodeStar.Mixins.CfnGitHubRepositoryPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscodestar/mixins#CfnGitHubRepositoryPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.codestar.mixins.CfnGitHubRepositoryPropsMixin
Python	aws_cdk.mixins_preview.aws_codestar.mixins.CfnGitHubRepositoryPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_codestar » mixins » CfnGitHubRepositoryPropsMixin

Implements IMixin

Extends Mixin

The AWS::CodeStar::GitHubRepository resource creates a GitHub repository where users can store source code for use with AWS workflows.

You must provide a location for the source code ZIP file in the CloudFormation template, so the code can be uploaded to the created repository. You must have created a personal access token in GitHub to provide in the CloudFormation template. AWS uses this token to connect to GitHub on your behalf.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as codestar_mixins } from '@aws-cdk/mixins-preview/aws-codestar';
const cfnGitHubRepositoryPropsMixin = new codestar_mixins.CfnGitHubRepositoryPropsMixin({
  code: {
    s3: {
      bucket: 'bucket',
      key: 'key',
      objectVersion: 'objectVersion',
    },
  },
  connectionArn: 'connectionArn',
  enableIssues: false,
  isPrivate: false,
  repositoryAccessToken: 'repositoryAccessToken',
  repositoryDescription: 'repositoryDescription',
  repositoryName: 'repositoryName',
  repositoryOwner: 'repositoryOwner',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnGitHubRepositoryPropsMixin(props: CfnGitHubRepositoryMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnGitHubRepositoryMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CodeStar::GitHubRepository.

Properties

Name	Type	Description
props	CfnGitHubRepositoryMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnGitHubRepositoryMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.