CfnGitHubRepository

class aws_cdk.aws_codestar.CfnGitHubRepository(scope, id, *, repository_name, repository_owner, code=None, connection_arn=None, enable_issues=None, is_private=None, repository_access_token=None, repository_description=None)

Bases: aws_cdk.core.CfnResource

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 .

CloudformationResource

AWS::CodeStar::GitHubRepository

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codestar as codestar

cfn_git_hub_repository = codestar.CfnGitHubRepository(self, "MyCfnGitHubRepository",
    repository_name="repositoryName",
    repository_owner="repositoryOwner",

    # the properties below are optional
    code=codestar.CfnGitHubRepository.CodeProperty(
        s3=codestar.CfnGitHubRepository.S3Property(
            bucket="bucket",
            key="key",

            # the properties below are optional
            object_version="objectVersion"
        )
    ),
    connection_arn="connectionArn",
    enable_issues=False,
    is_private=False,
    repository_access_token="repositoryAccessToken",
    repository_description="repositoryDescription"
)

Create a new AWS::CodeStar::GitHubRepository.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • repository_name (str) – The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.

  • repository_owner (str) – 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.

  • code (Union[CodeProperty, IResolvable, None]) – Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.

  • connection_arn (Optional[str]) – AWS::CodeStar::GitHubRepository.ConnectionArn.

  • enable_issues (Union[bool, IResolvable, None]) – Indicates whether to enable issues for the GitHub repository. You can use GitHub issues to track information and bugs for your repository.

  • is_private (Union[bool, IResolvable, None]) – Indicates whether the GitHub repository is a private repository. If so, you choose who can see and commit to this repository.

  • repository_access_token (Optional[str]) – The GitHub user’s personal access token for the GitHub repository.

  • repository_description (Optional[str]) – A comment or description about the new repository. This description is displayed in GitHub after the repository is created.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CodeStar::GitHubRepository'
cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

code

Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-code

Return type

Union[CodeProperty, IResolvable, None]

connection_arn

AWS::CodeStar::GitHubRepository.ConnectionArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-connectionarn

Return type

Optional[str]

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

enable_issues

Indicates whether to enable issues for the GitHub repository.

You can use GitHub issues to track information and bugs for your repository.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-enableissues

Return type

Union[bool, IResolvable, None]

is_private

Indicates whether the GitHub repository is a private repository.

If so, you choose who can see and commit to this repository.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-isprivate

Return type

Union[bool, IResolvable, None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

repository_access_token

The GitHub user’s personal access token for the GitHub repository.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryaccesstoken

Return type

Optional[str]

repository_description

A comment or description about the new repository.

This description is displayed in GitHub after the repository is created.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositorydescription

Return type

Optional[str]

repository_name

The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryname

Return type

str

repository_owner

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryowner

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

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.

Parameters

x (Any) –

Return type

bool

Returns

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

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

CodeProperty

class CfnGitHubRepository.CodeProperty(*, s3)

Bases: object

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

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

Parameters

s3 (Union[IResolvable, S3Property]) – Information about the Amazon S3 bucket that contains a ZIP file of code to be committed to the repository.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-code.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codestar as codestar

code_property = codestar.CfnGitHubRepository.CodeProperty(
    s3=codestar.CfnGitHubRepository.S3Property(
        bucket="bucket",
        key="key",

        # the properties below are optional
        object_version="objectVersion"
    )
)

Attributes

s3

Information about the Amazon S3 bucket that contains a ZIP file of code to be committed to the repository.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-code.html#cfn-codestar-githubrepository-code-s3

Return type

Union[IResolvable, S3Property]

S3Property

class CfnGitHubRepository.S3Property(*, bucket, key, object_version=None)

Bases: object

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.

Parameters
  • bucket (str) – The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.

  • key (str) – The S3 object key or file name for the ZIP file.

  • object_version (Optional[str]) – The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codestar as codestar

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

    # the properties below are optional
    object_version="objectVersion"
)

Attributes

bucket

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html#cfn-codestar-githubrepository-s3-bucket

Return type

str

key

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html#cfn-codestar-githubrepository-s3-key

Return type

str

object_version

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codestar-githubrepository-s3.html#cfn-codestar-githubrepository-s3-objectversion

Return type

Optional[str]