awscodestar

Documentation

Index

• func CfnGitHubRepository_CFN_RESOURCE_TYPE_NAME() *string
• func CfnGitHubRepository_IsCfnElement(x interface{}) *bool
• func CfnGitHubRepository_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnGitHubRepository_IsConstruct(x interface{}) *bool
• func GitHubRepository_IsConstruct(x interface{}) *bool
• func GitHubRepository_IsResource(construct awscdk.IConstruct) *bool
• func NewCfnGitHubRepository_Override(c CfnGitHubRepository, scope awscdk.Construct, id *string, ...)
• func NewGitHubRepository_Override(g GitHubRepository, scope constructs.Construct, id *string, ...)
• type CfnGitHubRepository
  • func NewCfnGitHubRepository(scope awscdk.Construct, id *string, props *CfnGitHubRepositoryProps) CfnGitHubRepository
• type CfnGitHubRepositoryProps
• type CfnGitHubRepository_CodeProperty
• type CfnGitHubRepository_S3Property
• type GitHubRepository
  • func NewGitHubRepository(scope constructs.Construct, id *string, props *GitHubRepositoryProps) GitHubRepository
• type GitHubRepositoryProps
• type IGitHubRepository
• type RepositoryVisibility

Functions

func CfnGitHubRepository_CFN_RESOURCE_TYPE_NAME

func CfnGitHubRepository_CFN_RESOURCE_TYPE_NAME() *string

func CfnGitHubRepository_IsCfnElement

func CfnGitHubRepository_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.

func CfnGitHubRepository_IsCfnResource

func CfnGitHubRepository_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnGitHubRepository_IsConstruct

func CfnGitHubRepository_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func GitHubRepository_IsConstruct

func GitHubRepository_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func GitHubRepository_IsResource

func GitHubRepository_IsResource(construct awscdk.IConstruct) *bool

Check whether the given construct is a Resource. Experimental.

func NewCfnGitHubRepository_Override

func NewCfnGitHubRepository_Override(c CfnGitHubRepository, scope awscdk.Construct, id *string, props *CfnGitHubRepositoryProps)

Create a new `AWS::CodeStar::GitHubRepository`.

func NewGitHubRepository_Override

func NewGitHubRepository_Override(g GitHubRepository, scope constructs.Construct, id *string, props *GitHubRepositoryProps)

Experimental.

Types

type CfnGitHubRepository

type CfnGitHubRepository interface {
	awscdk.CfnResource
	awscdk.IInspectable
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Code() interface{}
	SetCode(val interface{})
	ConnectionArn() *string
	SetConnectionArn(val *string)
	CreationStack() *[]*string
	EnableIssues() interface{}
	SetEnableIssues(val interface{})
	IsPrivate() interface{}
	SetIsPrivate(val interface{})
	LogicalId() *string
	Node() awscdk.ConstructNode
	Ref() *string
	RepositoryAccessToken() *string
	SetRepositoryAccessToken(val *string)
	RepositoryDescription() *string
	SetRepositoryDescription(val *string)
	RepositoryName() *string
	SetRepositoryName(val *string)
	RepositoryOwner() *string
	SetRepositoryOwner(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	OverrideLogicalId(newLogicalId *string)
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CodeStar::GitHubRepository`.

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 AWS 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 AWS CloudFormation template. AWS uses this token to connect to GitHub on your behalf. For more information about using a GitHub source repository with AWS CodeStar projects, see [AWS CodeStar Project Files and Resources](https://docs.aws.amazon.com/codestar/latest/userguide/templates.html#templates-whatis) .

TODO: EXAMPLE

func NewCfnGitHubRepository

func NewCfnGitHubRepository(scope awscdk.Construct, id *string, props *CfnGitHubRepositoryProps) CfnGitHubRepository

Create a new `AWS::CodeStar::GitHubRepository`.

type CfnGitHubRepositoryProps

type CfnGitHubRepositoryProps struct {
	// The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
	RepositoryName *string `json:"repositoryName" yaml:"repositoryName"`
	// The GitHub user name for the owner of the GitHub repository to be created.
	//
	// If this repository should be owned by a GitHub organization, provide its name.
	RepositoryOwner *string `json:"repositoryOwner" yaml:"repositoryOwner"`
	// Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
	Code interface{} `json:"code" yaml:"code"`
	// `AWS::CodeStar::GitHubRepository.ConnectionArn`.
	ConnectionArn *string `json:"connectionArn" yaml:"connectionArn"`
	// Indicates whether to enable issues for the GitHub repository.
	//
	// You can use GitHub issues to track information and bugs for your repository.
	EnableIssues interface{} `json:"enableIssues" yaml:"enableIssues"`
	// Indicates whether the GitHub repository is a private repository.
	//
	// If so, you choose who can see and commit to this repository.
	IsPrivate interface{} `json:"isPrivate" yaml:"isPrivate"`
	// The GitHub user's personal access token for the GitHub repository.
	RepositoryAccessToken *string `json:"repositoryAccessToken" yaml:"repositoryAccessToken"`
	// A comment or description about the new repository.
	//
	// This description is displayed in GitHub after the repository is created.
	RepositoryDescription *string `json:"repositoryDescription" yaml:"repositoryDescription"`
}

Properties for defining a `CfnGitHubRepository`.

TODO: EXAMPLE

type CfnGitHubRepository_CodeProperty

type CfnGitHubRepository_CodeProperty struct {
	// Information about the Amazon S3 bucket that contains a ZIP file of code to be committed to the repository.
	S3 interface{} `json:"s3" yaml:"s3"`
}

The `Code` property type specifies information about code to be committed.

`Code` is a property of the `AWS::CodeStar::GitHubRepository` resource.

TODO: EXAMPLE

type CfnGitHubRepository_S3Property

type CfnGitHubRepository_S3Property struct {
	// The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.
	Bucket *string `json:"bucket" yaml:"bucket"`
	// The S3 object key or file name for the ZIP file.
	Key *string `json:"key" yaml:"key"`
	// The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.
	ObjectVersion *string `json:"objectVersion" yaml:"objectVersion"`
}

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.

TODO: EXAMPLE

type GitHubRepository

type GitHubRepository interface {
	awscdk.Resource
	IGitHubRepository
	Env() *awscdk.ResourceEnvironment
	Node() awscdk.ConstructNode
	Owner() *string
	PhysicalName() *string
	Repo() *string
	Stack() awscdk.Stack
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
	GeneratePhysicalName() *string
	GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
	GetResourceNameAttribute(nameAttr *string) *string
	OnPrepare()
	OnSynthesize(session constructs.ISynthesisSession)
	OnValidate() *[]*string
	Prepare()
	Synthesize(session awscdk.ISynthesisSession)
	ToString() *string
	Validate() *[]*string
}

The GitHubRepository resource.

TODO: EXAMPLE

Experimental.

func NewGitHubRepository

func NewGitHubRepository(scope constructs.Construct, id *string, props *GitHubRepositoryProps) GitHubRepository

Experimental.

type GitHubRepositoryProps

type GitHubRepositoryProps struct {
	// The GitHub user's personal access token for the GitHub repository.
	// Experimental.
	AccessToken awscdk.SecretValue `json:"accessToken" yaml:"accessToken"`
	// The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.
	// Experimental.
	ContentsBucket awss3.IBucket `json:"contentsBucket" yaml:"contentsBucket"`
	// The S3 object key or file name for the ZIP file.
	// Experimental.
	ContentsKey *string `json:"contentsKey" yaml:"contentsKey"`
	// The GitHub user name for the owner of the GitHub repository to be created.
	//
	// If this
	// repository should be owned by a GitHub organization, provide its name
	// Experimental.
	Owner *string `json:"owner" yaml:"owner"`
	// The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
	// Experimental.
	RepositoryName *string `json:"repositoryName" yaml:"repositoryName"`
	// The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.
	// Experimental.
	ContentsS3Version *string `json:"contentsS3Version" yaml:"contentsS3Version"`
	// A comment or description about the new repository.
	//
	// This description is displayed in GitHub after the repository
	// is created.
	// Experimental.
	Description *string `json:"description" yaml:"description"`
	// Indicates whether to enable issues for the GitHub repository.
	//
	// You can use GitHub issues to track information
	// and bugs for your repository.
	// Experimental.
	EnableIssues *bool `json:"enableIssues" yaml:"enableIssues"`
	// Indicates whether the GitHub repository is a private repository.
	//
	// If so, you choose who can see and commit to
	// this repository.
	// Experimental.
	Visibility RepositoryVisibility `json:"visibility" yaml:"visibility"`
}

Construction properties of {@link GitHubRepository}.

TODO: EXAMPLE

Experimental.

type IGitHubRepository

type IGitHubRepository interface {
	awscdk.IResource
	// the repository owner.
	// Experimental.
	Owner() *string
	// the repository name.
	// Experimental.
	Repo() *string
}

GitHubRepository resource interface. Experimental.

type RepositoryVisibility

type RepositoryVisibility string

Visibility of the GitHubRepository. Experimental.

const (
	RepositoryVisibility_PRIVATE RepositoryVisibility = "PRIVATE"
	RepositoryVisibility_PUBLIC  RepositoryVisibility = "PUBLIC"
)