Class: AWS.CodeConnections

var params = {
  Name: 'STRING_VALUE', /* required */
  ProviderEndpoint: 'STRING_VALUE', /* required */
  ProviderType: Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManaged, /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VpcConfiguration: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    VpcId: 'STRING_VALUE', /* required */
    TlsCertificate: 'STRING_VALUE'
  }
};
codeconnections.createHost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the host to be created.

  • ProviderType — (String)

    The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

    Possible values include:
    • "Bitbucket"
    • "GitHub"
    • "GitHubEnterpriseServer"
    • "GitLab"
    • "GitLabSelfManaged"
  • ProviderEndpoint — (String)

    The endpoint of the infrastructure to be represented by the host after it is created.

  • VpcConfiguration — (map)

    The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.

    • VpcId — required — (String)

      The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

    • SubnetIds — required — (Array<String>)

      The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

    • SecurityGroupIds — required — (Array<String>)

      The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

    • TlsCertificate — (String)

      The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

  • Tags — (Array<map>)

    Tags for the host to be created.

    • Key — required — (String)

      The tag's key.

    • Value — required — (String)

      The tag's value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HostArn — (String)

      The Amazon Resource Name (ARN) of the host to be created.

    • Tags — (Array<map>)

      Tags for the created host.

      • Key — required — (String)

        The tag's key.

      • Value — required — (String)

        The tag's value.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConnectionArn: 'STRING_VALUE', /* required */
  OwnerId: 'STRING_VALUE', /* required */
  RepositoryName: 'STRING_VALUE', /* required */
  EncryptionKeyArn: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codeconnections.createRepositoryLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ConnectionArn — (String)

    The Amazon Resource Name (ARN) of the connection to be associated with the repository link.

  • OwnerId — (String)

    The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

  • RepositoryName — (String)

    The name of the repository to be associated with the repository link.

  • EncryptionKeyArn — (String)

    The Amazon Resource Name (ARN) encryption key for the repository to be associated with the repository link.

  • Tags — (Array<map>)

    The tags for the repository to be associated with the repository link.

    • Key — required — (String)

      The tag's key.

    • Value — required — (String)

      The tag's value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RepositoryLinkInfo — (map)

      The returned information about the created repository link.

      • ConnectionArn — required — (String)

        The Amazon Resource Name (ARN) of the connection associated with the repository link.

      • EncryptionKeyArn — (String)

        The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.

      • OwnerId — required — (String)

        The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.

      • ProviderType — required — (String)

        The provider type for the connection, such as GitHub, associated with the repository link.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • RepositoryLinkArn — required — (String)

        The Amazon Resource Name (ARN) of the repository link.

      • RepositoryLinkId — required — (String)

        The ID of the repository link.

      • RepositoryName — required — (String)

        The name of the repository associated with the repository link.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Branch: 'STRING_VALUE', /* required */
  ConfigFile: 'STRING_VALUE', /* required */
  RepositoryLinkId: 'STRING_VALUE', /* required */
  ResourceName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC, /* required */
  PublishDeploymentStatus: ENABLED | DISABLED,
  TriggerResourceUpdateOn: ANY_CHANGE | FILE_CHANGE
};
codeconnections.createSyncConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Branch — (String)

    The branch in the repository from which changes will be synced.

  • ConfigFile — (String)

    The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.

  • RepositoryLinkId — (String)

    The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

  • ResourceName — (String)

    The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.

  • RoleArn — (String)

    The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.

  • SyncType — (String)

    The type of sync configuration.

    Possible values include:
    • "CFN_STACK_SYNC"
  • PublishDeploymentStatus — (String)

    Whether to enable or disable publishing of deployment status to source providers.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • TriggerResourceUpdateOn — (String)

    When to trigger Git sync to begin the stack update.

    Possible values include:
    • "ANY_CHANGE"
    • "FILE_CHANGE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SyncConfiguration — (map)

      The created sync configuration for the connection. A sync configuration allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource.

      • Branch — required — (String)

        The branch associated with a specific sync configuration.

      • ConfigFile — (String)

        The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.

      • OwnerId — required — (String)

        The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

      • ProviderType — required — (String)

        The connection provider type associated with a specific sync configuration, such as GitHub.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • RepositoryLinkId — required — (String)

        The ID of the repository link associated with a specific sync configuration.

      • RepositoryName — required — (String)

        The name of the repository associated with a specific sync configuration.

      • ResourceName — required — (String)

        The name of the connection resource associated with a specific sync configuration.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

      • SyncType — required — (String)

        The type of sync for a specific sync configuration.

        Possible values include:
        • "CFN_STACK_SYNC"
      • PublishDeploymentStatus — (String)

        Whether to enable or disable publishing of deployment status to source providers.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • TriggerResourceUpdateOn — (String)

        When to trigger Git sync to begin the stack update.

        Possible values include:
        • "ANY_CHANGE"
        • "FILE_CHANGE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConnectionArn: 'STRING_VALUE' /* required */
};
codeconnections.deleteConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ConnectionArn — (String)

    The Amazon Resource Name (ARN) of the connection to be deleted.

    Note: The ARN is never reused if the connection is deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HostArn: 'STRING_VALUE' /* required */
};
codeconnections.deleteHost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HostArn — (String)

    The Amazon Resource Name (ARN) of the host to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RepositoryLinkId: 'STRING_VALUE' /* required */
};
codeconnections.deleteRepositoryLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RepositoryLinkId — (String)

    The ID of the repository link to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codeconnections.deleteSyncConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SyncType — (String)

    The type of sync configuration to be deleted.

    Possible values include:
    • "CFN_STACK_SYNC"
  • ResourceName — (String)

    The name of the Amazon Web Services resource associated with the sync configuration to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ConnectionArn: 'STRING_VALUE' /* required */
};
codeconnections.getConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ConnectionArn — (String)

    The Amazon Resource Name (ARN) of a connection.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Connection — (map)

      The connection details, such as status, owner, and provider type.

      • ConnectionName — (String)

        The name of the connection. Connection names must be unique in an Amazon Web Services account.

      • ConnectionArn — (String)

        The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between Amazon Web Services.

        Note: The ARN is never reused if the connection is deleted.
      • ProviderType — (String)

        The name of the external provider where your third-party code repository is configured.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • OwnerAccountId — (String)

        The identifier of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

      • ConnectionStatus — (String)

        The current status of the connection.

        Possible values include:
        • "PENDING"
        • "AVAILABLE"
        • "ERROR"
      • HostArn — (String)

        The Amazon Resource Name (ARN) of the host associated with the connection.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HostArn: 'STRING_VALUE' /* required */
};
codeconnections.getHost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HostArn — (String)

    The Amazon Resource Name (ARN) of the requested host.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the requested host.

    • Status — (String)

      The status of the requested host.

    • ProviderType — (String)

      The provider type of the requested host, such as GitHub Enterprise Server.

      Possible values include:
      • "Bitbucket"
      • "GitHub"
      • "GitHubEnterpriseServer"
      • "GitLab"
      • "GitLabSelfManaged"
    • ProviderEndpoint — (String)

      The endpoint of the infrastructure represented by the requested host.

    • VpcConfiguration — (map)

      The VPC configuration of the requested host.

      • VpcId — required — (String)

        The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

      • SubnetIds — required — (Array<String>)

        The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

      • SecurityGroupIds — required — (Array<String>)

        The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

      • TlsCertificate — (String)

        The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RepositoryLinkId: 'STRING_VALUE' /* required */
};
codeconnections.getRepositoryLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RepositoryLinkId — (String)

    The ID of the repository link to get.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RepositoryLinkInfo — (map)

      The information returned for a specified repository link.

      • ConnectionArn — required — (String)

        The Amazon Resource Name (ARN) of the connection associated with the repository link.

      • EncryptionKeyArn — (String)

        The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.

      • OwnerId — required — (String)

        The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.

      • ProviderType — required — (String)

        The provider type for the connection, such as GitHub, associated with the repository link.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • RepositoryLinkArn — required — (String)

        The Amazon Resource Name (ARN) of the repository link.

      • RepositoryLinkId — required — (String)

        The ID of the repository link.

      • RepositoryName — required — (String)

        The name of the repository associated with the repository link.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Branch: 'STRING_VALUE', /* required */
  RepositoryLinkId: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codeconnections.getRepositorySyncStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Branch — (String)

    The branch of the repository link for the requested repository sync status.

  • RepositoryLinkId — (String)

    The repository link ID for the requested repository sync status.

  • SyncType — (String)

    The sync type of the requested sync status.

    Possible values include:
    • "CFN_STACK_SYNC"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • LatestSync — (map)

      The status of the latest sync returned for a specified repository and branch.

      • StartedAt — required — (Date)

        The start time of a specific sync attempt.

      • Status — required — (String)

        The status of a specific sync attempt. The following are valid statuses:

        • INITIATED - A repository sync attempt has been created and will begin soon.

        • IN_PROGRESS - A repository sync attempt has started and work is being done to reconcile the branch.

        • SUCCEEDED - The repository sync attempt has completed successfully.

        • FAILED - The repository sync attempt has failed.

        • QUEUED - The repository sync attempt didn't execute and was queued.

        Possible values include:
        • "FAILED"
        • "INITIATED"
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "QUEUED"
      • Events — required — (Array<map>)

        The events associated with a specific sync attempt.

        • Event — required — (String)

          A description of a repository sync event.

        • ExternalId — (String)

          The ID for a repository sync event.

        • Time — required — (Date)

          The time that a repository sync event occurred.

        • Type — required — (String)

          The event type for a repository sync event.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codeconnections.getResourceSyncStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceName — (String)

    The name of the Amazon Web Services resource for the sync status with the Git repository.

  • SyncType — (String)

    The sync type for the sync status with the Git repository.

    Possible values include:
    • "CFN_STACK_SYNC"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DesiredState — (map)

      The desired state of the Amazon Web Services resource for the sync status with the Git repository.

      • Branch — required — (String)

        The branch name for a specific revision.

      • Directory — required — (String)

        The directory, if any, for a specific revision.

      • OwnerId — required — (String)

        The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.

      • RepositoryName — required — (String)

        The repository name for a specific revision.

      • ProviderType — required — (String)

        The provider type for a revision, such as GitHub.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • Sha — required — (String)

        The SHA, such as the commit ID, for a specific revision.

    • LatestSuccessfulSync — (map)

      The latest successful sync for the sync status with the Git repository.

      • Events — required — (Array<map>)

        The events related to a resource sync attempt.

        • Event — required — (String)

          The event for a resource sync event.

        • ExternalId — (String)

          The ID for a resource sync event.

        • Time — required — (Date)

          The time that a resource sync event occurred.

        • Type — required — (String)

          The type of resource sync event.

      • InitialRevision — required — (map)

        The current state of the resource as defined in the resource's config-file in the linked repository.

        • Branch — required — (String)

          The branch name for a specific revision.

        • Directory — required — (String)

          The directory, if any, for a specific revision.

        • OwnerId — required — (String)

          The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.

        • RepositoryName — required — (String)

          The repository name for a specific revision.

        • ProviderType — required — (String)

          The provider type for a revision, such as GitHub.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • Sha — required — (String)

          The SHA, such as the commit ID, for a specific revision.

      • StartedAt — required — (Date)

        The start time for a resource sync attempt.

      • Status — required — (String)

        The status for a resource sync attempt. The follow are valid statuses:

        • SYNC-INITIATED - A resource sync attempt has been created and will begin soon.

        • SYNCING - Syncing has started and work is being done to reconcile state.

        • SYNCED - Syncing has completed successfully.

        • SYNC_FAILED - A resource sync attempt has failed.

        Possible values include:
        • "FAILED"
        • "INITIATED"
        • "IN_PROGRESS"
        • "SUCCEEDED"
      • TargetRevision — required — (map)

        The desired state of the resource as defined in the resource's config-file in the linked repository. Git sync attempts to update the resource to this state.

        • Branch — required — (String)

          The branch name for a specific revision.

        • Directory — required — (String)

          The directory, if any, for a specific revision.

        • OwnerId — required — (String)

          The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.

        • RepositoryName — required — (String)

          The repository name for a specific revision.

        • ProviderType — required — (String)

          The provider type for a revision, such as GitHub.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • Sha — required — (String)

          The SHA, such as the commit ID, for a specific revision.

      • Target — required — (String)

        The name of the Amazon Web Services resource that is attempted to be synchronized.

    • LatestSync — (map)

      The latest sync for the sync status with the Git repository, whether successful or not.

      • Events — required — (Array<map>)

        The events related to a resource sync attempt.

        • Event — required — (String)

          The event for a resource sync event.

        • ExternalId — (String)

          The ID for a resource sync event.

        • Time — required — (Date)

          The time that a resource sync event occurred.

        • Type — required — (String)

          The type of resource sync event.

      • InitialRevision — required — (map)

        The current state of the resource as defined in the resource's config-file in the linked repository.

        • Branch — required — (String)

          The branch name for a specific revision.

        • Directory — required — (String)

          The directory, if any, for a specific revision.

        • OwnerId — required — (String)

          The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.

        • RepositoryName — required — (String)

          The repository name for a specific revision.

        • ProviderType — required — (String)

          The provider type for a revision, such as GitHub.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • Sha — required — (String)

          The SHA, such as the commit ID, for a specific revision.

      • StartedAt — required — (Date)

        The start time for a resource sync attempt.

      • Status — required — (String)

        The status for a resource sync attempt. The follow are valid statuses:

        • SYNC-INITIATED - A resource sync attempt has been created and will begin soon.

        • SYNCING - Syncing has started and work is being done to reconcile state.

        • SYNCED - Syncing has completed successfully.

        • SYNC_FAILED - A resource sync attempt has failed.

        Possible values include:
        • "FAILED"
        • "INITIATED"
        • "IN_PROGRESS"
        • "SUCCEEDED"
      • TargetRevision — required — (map)

        The desired state of the resource as defined in the resource's config-file in the linked repository. Git sync attempts to update the resource to this state.

        • Branch — required — (String)

          The branch name for a specific revision.

        • Directory — required — (String)

          The directory, if any, for a specific revision.

        • OwnerId — required — (String)

          The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.

        • RepositoryName — required — (String)

          The repository name for a specific revision.

        • ProviderType — required — (String)

          The provider type for a revision, such as GitHub.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • Sha — required — (String)

          The SHA, such as the commit ID, for a specific revision.

      • Target — required — (String)

        The name of the Amazon Web Services resource that is attempted to be synchronized.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codeconnections.getSyncBlockerSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SyncType — (String)

    The sync type for the sync blocker summary.

    Possible values include:
    • "CFN_STACK_SYNC"
  • ResourceName — (String)

    The name of the Amazon Web Services resource currently blocked from automatically being synced from a Git repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SyncBlockerSummary — (map)

      The list of sync blockers for a specified resource.

      • ResourceName — required — (String)

        The resource name for sync blocker summary.

      • ParentResourceName — (String)

        The parent resource name for a sync blocker summary.

      • LatestBlockers — (Array<map>)

        The latest events for a sync blocker summary.

        • Id — required — (String)

          The ID for a specific sync blocker.

        • Type — required — (String)

          The sync blocker type.

          Possible values include:
          • "AUTOMATED"
        • Status — required — (String)

          The status for a specific sync blocker.

          Possible values include:
          • "ACTIVE"
          • "RESOLVED"
        • CreatedReason — required — (String)

          The provided reason for a specific sync blocker.

        • CreatedAt — required — (Date)

          The creation time for a specific sync blocker.

        • Contexts — (Array<map>)

          The contexts for a specific sync blocker.

          • Key — required — (String)

            The key provided for a context key-value pair for a specific sync blocker.

          • Value — required — (String)

            The value provided for a context key-value pair for a specific sync blocker.

        • ResolvedReason — (String)

          The resolved reason for a specific sync blocker.

        • ResolvedAt — (Date)

          The time that a specific sync blocker was resolved.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codeconnections.getSyncConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SyncType — (String)

    The sync type for the sync configuration for which you want to retrieve information.

    Possible values include:
    • "CFN_STACK_SYNC"
  • ResourceName — (String)

    The name of the Amazon Web Services resource for the sync configuration for which you want to retrieve information.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SyncConfiguration — (map)

      The details about the sync configuration for which you want to retrieve information.

      • Branch — required — (String)

        The branch associated with a specific sync configuration.

      • ConfigFile — (String)

        The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.

      • OwnerId — required — (String)

        The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

      • ProviderType — required — (String)

        The connection provider type associated with a specific sync configuration, such as GitHub.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • RepositoryLinkId — required — (String)

        The ID of the repository link associated with a specific sync configuration.

      • RepositoryName — required — (String)

        The name of the repository associated with a specific sync configuration.

      • ResourceName — required — (String)

        The name of the connection resource associated with a specific sync configuration.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

      • SyncType — required — (String)

        The type of sync for a specific sync configuration.

        Possible values include:
        • "CFN_STACK_SYNC"
      • PublishDeploymentStatus — (String)

        Whether to enable or disable publishing of deployment status to source providers.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • TriggerResourceUpdateOn — (String)

        When to trigger Git sync to begin the stack update.

        Possible values include:
        • "ANY_CHANGE"
        • "FILE_CHANGE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HostArnFilter: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProviderTypeFilter: Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManaged
};
codeconnections.listConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ProviderTypeFilter — (String)

    Filters the list of connections to those associated with a specified provider, such as Bitbucket.

    Possible values include:
    • "Bitbucket"
    • "GitHub"
    • "GitHubEnterpriseServer"
    • "GitLab"
    • "GitLabSelfManaged"
  • HostArnFilter — (String)

    Filters the list of connections to those associated with a specified host.

  • MaxResults — (Integer)

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • NextToken — (String)

    The token that was returned from the previous ListConnections call, which can be used to return the next set of connections in the list.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Connections — (Array<map>)

      A list of connections and the details for each connection, such as status, owner, and provider type.

      • ConnectionName — (String)

        The name of the connection. Connection names must be unique in an Amazon Web Services account.

      • ConnectionArn — (String)

        The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between Amazon Web Services.

        Note: The ARN is never reused if the connection is deleted.
      • ProviderType — (String)

        The name of the external provider where your third-party code repository is configured.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • OwnerAccountId — (String)

        The identifier of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

      • ConnectionStatus — (String)

        The current status of the connection.

        Possible values include:
        • "PENDING"
        • "AVAILABLE"
        • "ERROR"
      • HostArn — (String)

        The Amazon Resource Name (ARN) of the host associated with the connection.

    • NextToken — (String)

      A token that can be used in the next ListConnections call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
codeconnections.listHosts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • NextToken — (String)

    The token that was returned from the previous ListHosts call, which can be used to return the next set of hosts in the list.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Hosts — (Array<map>)

      A list of hosts and the details for each host, such as status, endpoint, and provider type.

      • Name — (String)

        The name of the host.

      • HostArn — (String)

        The Amazon Resource Name (ARN) of the host.

      • ProviderType — (String)

        The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • ProviderEndpoint — (String)

        The endpoint of the infrastructure where your provider type is installed.

      • VpcConfiguration — (map)

        The VPC configuration provisioned for the host.

        • VpcId — required — (String)

          The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

        • SubnetIds — required — (Array<String>)

          The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

        • SecurityGroupIds — required — (Array<String>)

          The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

        • TlsCertificate — (String)

          The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

      • Status — (String)

        The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

      • StatusMessage — (String)

        The status description for the host.

    • NextToken — (String)

      A token that can be used in the next ListHosts call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
codeconnections.listRepositoryLinks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    A non-zero, non-negative integer used to limit the number of returned results.

  • NextToken — (String)

    An enumeration token that, when provided in a request, returns the next batch of the results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RepositoryLinks — (Array<map>)

      Lists the repository links called by the list repository links operation.

      • ConnectionArn — required — (String)

        The Amazon Resource Name (ARN) of the connection associated with the repository link.

      • EncryptionKeyArn — (String)

        The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.

      • OwnerId — required — (String)

        The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.

      • ProviderType — required — (String)

        The provider type for the connection, such as GitHub, associated with the repository link.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • RepositoryLinkArn — required — (String)

        The Amazon Resource Name (ARN) of the repository link.

      • RepositoryLinkId — required — (String)

        The ID of the repository link.

      • RepositoryName — required — (String)

        The name of the repository associated with the repository link.

    • NextToken — (String)

      An enumeration token that allows the operation to batch the results of the operation.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RepositoryLinkId: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codeconnections.listRepositorySyncDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RepositoryLinkId — (String)

    The ID of the repository link for the sync definition for which you want to retrieve information.

  • SyncType — (String)

    The sync type of the repository link for the the sync definition for which you want to retrieve information.

    Possible values include:
    • "CFN_STACK_SYNC"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RepositorySyncDefinitions — (Array<map>)

      The list of repository sync definitions returned by the request. A RepositorySyncDefinition is a mapping from a repository branch to all the Amazon Web Services resources that are being synced from that branch.

      • Branch — required — (String)

        The branch specified for a repository sync definition.

      • Directory — required — (String)

        The configuration file for a repository sync definition. This value comes from creating or updating the config-file field of a sync-configuration.

      • Parent — required — (String)

        The parent resource specified for a repository sync definition.

      • Target — required — (String)

        The target resource specified for a repository sync definition. In some cases, such as CFN_STACK_SYNC, the parent and target resource are the same.

    • NextToken — (String)

      An enumeration token that, when provided in a request, returns the next batch of the results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RepositoryLinkId: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
codeconnections.listSyncConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    A non-zero, non-negative integer used to limit the number of returned results.

  • NextToken — (String)

    An enumeration token that allows the operation to batch the results of the operation.

  • RepositoryLinkId — (String)

    The ID of the repository link for the requested list of sync configurations.

  • SyncType — (String)

    The sync type for the requested list of sync configurations.

    Possible values include:
    • "CFN_STACK_SYNC"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SyncConfigurations — (Array<map>)

      The list of repository sync definitions returned by the request.

      • Branch — required — (String)

        The branch associated with a specific sync configuration.

      • ConfigFile — (String)

        The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.

      • OwnerId — required — (String)

        The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

      • ProviderType — required — (String)

        The connection provider type associated with a specific sync configuration, such as GitHub.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • RepositoryLinkId — required — (String)

        The ID of the repository link associated with a specific sync configuration.

      • RepositoryName — required — (String)

        The name of the repository associated with a specific sync configuration.

      • ResourceName — required — (String)

        The name of the connection resource associated with a specific sync configuration.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

      • SyncType — required — (String)

        The type of sync for a specific sync configuration.

        Possible values include:
        • "CFN_STACK_SYNC"
      • PublishDeploymentStatus — (String)

        Whether to enable or disable publishing of deployment status to source providers.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • TriggerResourceUpdateOn — (String)

        When to trigger Git sync to begin the stack update.

        Possible values include:
        • "ANY_CHANGE"
        • "FILE_CHANGE"
    • NextToken — (String)

      An enumeration token that allows the operation to batch the next results of the operation.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
codeconnections.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (Array<map>)

      A list of tag key and value pairs associated with the specified resource.

      • Key — required — (String)

        The tag's key.

      • Value — required — (String)

        The tag's value.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codeconnections.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.

  • Tags — (Array<map>)

    The tags you want to modify or add to the resource.

    • Key — required — (String)

      The tag's key.

    • Value — required — (String)

      The tag's value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
codeconnections.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource to remove tags from.

  • TagKeys — (Array<String>)

    The list of keys for the tags to be removed from the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HostArn: 'STRING_VALUE', /* required */
  ProviderEndpoint: 'STRING_VALUE',
  VpcConfiguration: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    VpcId: 'STRING_VALUE', /* required */
    TlsCertificate: 'STRING_VALUE'
  }
};
codeconnections.updateHost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HostArn — (String)

    The Amazon Resource Name (ARN) of the host to be updated.

  • ProviderEndpoint — (String)

    The URL or endpoint of the host to be updated.

  • VpcConfiguration — (map)

    The VPC configuration of the host to be updated. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.

    • VpcId — required — (String)

      The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

    • SubnetIds — required — (Array<String>)

      The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

    • SecurityGroupIds — required — (Array<String>)

      The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

    • TlsCertificate — (String)

      The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RepositoryLinkId: 'STRING_VALUE', /* required */
  ConnectionArn: 'STRING_VALUE',
  EncryptionKeyArn: 'STRING_VALUE'
};
codeconnections.updateRepositoryLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ConnectionArn — (String)

    The Amazon Resource Name (ARN) of the connection for the repository link to be updated. The updated connection ARN must have the same providerType (such as GitHub) as the original connection ARN for the repo link.

  • EncryptionKeyArn — (String)

    The Amazon Resource Name (ARN) of the encryption key for the repository link to be updated.

  • RepositoryLinkId — (String)

    The ID of the repository link to be updated.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RepositoryLinkInfo — (map)

      Information about the repository link to be updated.

      • ConnectionArn — required — (String)

        The Amazon Resource Name (ARN) of the connection associated with the repository link.

      • EncryptionKeyArn — (String)

        The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.

      • OwnerId — required — (String)

        The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.

      • ProviderType — required — (String)

        The provider type for the connection, such as GitHub, associated with the repository link.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • RepositoryLinkArn — required — (String)

        The Amazon Resource Name (ARN) of the repository link.

      • RepositoryLinkId — required — (String)

        The ID of the repository link.

      • RepositoryName — required — (String)

        The name of the repository associated with the repository link.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Id: 'STRING_VALUE', /* required */
  ResolvedReason: 'STRING_VALUE', /* required */
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codeconnections.updateSyncBlocker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Id — (String)

    The ID of the sync blocker to be updated.

  • SyncType — (String)

    The sync type of the sync blocker to be updated.

    Possible values include:
    • "CFN_STACK_SYNC"
  • ResourceName — (String)

    The name of the resource for the sync blocker to be updated.

  • ResolvedReason — (String)

    The reason for resolving the sync blocker.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ResourceName — (String)

      The resource name for the sync blocker.

    • ParentResourceName — (String)

      The parent resource name for the sync blocker.

    • SyncBlocker — (map)

      Information about the sync blocker to be updated.

      • Id — required — (String)

        The ID for a specific sync blocker.

      • Type — required — (String)

        The sync blocker type.

        Possible values include:
        • "AUTOMATED"
      • Status — required — (String)

        The status for a specific sync blocker.

        Possible values include:
        • "ACTIVE"
        • "RESOLVED"
      • CreatedReason — required — (String)

        The provided reason for a specific sync blocker.

      • CreatedAt — required — (Date)

        The creation time for a specific sync blocker.

      • Contexts — (Array<map>)

        The contexts for a specific sync blocker.

        • Key — required — (String)

          The key provided for a context key-value pair for a specific sync blocker.

        • Value — required — (String)

          The value provided for a context key-value pair for a specific sync blocker.

      • ResolvedReason — (String)

        The resolved reason for a specific sync blocker.

      • ResolvedAt — (Date)

        The time that a specific sync blocker was resolved.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC, /* required */
  Branch: 'STRING_VALUE',
  ConfigFile: 'STRING_VALUE',
  PublishDeploymentStatus: ENABLED | DISABLED,
  RepositoryLinkId: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  TriggerResourceUpdateOn: ANY_CHANGE | FILE_CHANGE
};
codeconnections.updateSyncConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Branch — (String)

    The branch for the sync configuration to be updated.

  • ConfigFile — (String)

    The configuration file for the sync configuration to be updated.

  • RepositoryLinkId — (String)

    The ID of the repository link for the sync configuration to be updated.

  • ResourceName — (String)

    The name of the Amazon Web Services resource for the sync configuration to be updated.

  • RoleArn — (String)

    The ARN of the IAM role for the sync configuration to be updated.

  • SyncType — (String)

    The sync type for the sync configuration to be updated.

    Possible values include:
    • "CFN_STACK_SYNC"
  • PublishDeploymentStatus — (String)

    Whether to enable or disable publishing of deployment status to source providers.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • TriggerResourceUpdateOn — (String)

    When to trigger Git sync to begin the stack update.

    Possible values include:
    • "ANY_CHANGE"
    • "FILE_CHANGE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SyncConfiguration — (map)

      The information returned for the sync configuration to be updated.

      • Branch — required — (String)

        The branch associated with a specific sync configuration.

      • ConfigFile — (String)

        The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.

      • OwnerId — required — (String)

        The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

      • ProviderType — required — (String)

        The connection provider type associated with a specific sync configuration, such as GitHub.

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • RepositoryLinkId — required — (String)

        The ID of the repository link associated with a specific sync configuration.

      • RepositoryName — required — (String)

        The name of the repository associated with a specific sync configuration.

      • ResourceName — required — (String)

        The name of the connection resource associated with a specific sync configuration.

      • RoleArn — required — (String)

        The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

      • SyncType — required — (String)

        The type of sync for a specific sync configuration.

        Possible values include:
        • "CFN_STACK_SYNC"
      • PublishDeploymentStatus — (String)

        Whether to enable or disable publishing of deployment status to source providers.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • TriggerResourceUpdateOn — (String)

        When to trigger Git sync to begin the stack update.

        Possible values include:
        • "ANY_CHANGE"
        • "FILE_CHANGE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.