Class: Aws::CodeGuruReviewer::Types::RepositoryAssociation

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codegurureviewer/types.rb

Overview

Information about a repository association. The

DescribeRepositoryAssociation][1

operation returns a

‘RepositoryAssociation` object.

[1]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#association_arnString

The Amazon Resource Name (ARN) identifying the repository association.

Returns:

  • (String)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#association_idString

The ID of the repository association.

Returns:

  • (String)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#connection_arnString

The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is ‘arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id`. For more information, see [Connection] in the *Amazon Web Services CodeStar Connections API Reference*.

[1]: docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html

Returns:

  • (String)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#created_time_stampTime

The time, in milliseconds since the epoch, when the repository association was created.

Returns:

  • (Time)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_detailsTypes::KMSKeyDetails

A ‘KMSKeyDetails` object that contains:

  • The encryption option for this repository association. It is either owned by Amazon Web Services Key Management Service (KMS) (‘AWS_OWNED_CMK`) or customer managed (`CUSTOMER_MANAGED_CMK`).

  • The ID of the Amazon Web Services KMS key that is associated with this repository association.



1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time_stampTime

The time, in milliseconds since the epoch, when the repository association was last updated.

Returns:

  • (Time)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the repository.

Returns:

  • (String)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#ownerString

The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.

Returns:

  • (String)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#provider_typeString

The provider type of the repository association.

Returns:

  • (String)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#s3_repository_detailsTypes::S3RepositoryDetails

Specifies the name of an S3 bucket and a ‘CodeArtifacts` object that contains the S3 object keys for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.



1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The state of the repository association.

The valid repository association states are:

  • Associated: The repository association is complete.

  • Associating: CodeGuru Reviewer is:

    • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

      <note markdown=“1”> If your repository ‘ProviderType` is `GitHub`, `GitHub Enterprise Server`, or `Bitbucket`, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

      </note>
      
    • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

  • Failed: The repository failed to associate or disassociate.

  • Disassociating: CodeGuru Reviewer is removing the repository’s pull request notifications and source code access.

  • Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in anassociated repository with tags after it has been disassociated. For more information, see [Using tags to control access to associated repositories] in the *Amazon CodeGuru Reviewer User Guide*.

[1]: docs.aws.amazon.com/codeguru/latest/reviewer-ug/auth-and-access-control-using-tags.html

Returns:

  • (String)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end

#state_reasonString

A description of why the repository association is in the current state.

Returns:

  • (String)


1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/aws-sdk-codegurureviewer/types.rb', line 1579

class RepositoryAssociation < Struct.new(
  :association_id,
  :association_arn,
  :connection_arn,
  :name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :last_updated_time_stamp,
  :created_time_stamp,
  :kms_key_details,
  :s3_repository_details)
  SENSITIVE = []
  include Aws::Structure
end