546 lines
22 KiB
TypeScript
546 lines
22 KiB
TypeScript
import * as cdk from "../../core/lib";
|
|
import * as constructs from "constructs";
|
|
import * as cfn_parse from "../../core/lib/helpers-internal";
|
|
import { ConnectionReference, IConnectionRef, IRepositoryLinkRef, ISyncConfigurationRef, RepositoryLinkReference, SyncConfigurationReference } from "../../interfaces/generated/aws-codestarconnections-interfaces.generated";
|
|
/**
|
|
* The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline .
|
|
*
|
|
* *Note:* A connection created through CloudFormation is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the connection in the console.
|
|
*
|
|
* @cloudformationResource AWS::CodeStarConnections::Connection
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html
|
|
*/
|
|
export declare class CfnConnection extends cdk.CfnResource implements cdk.IInspectable, IConnectionRef, cdk.ITaggable {
|
|
/**
|
|
* The CloudFormation resource type name for this resource class.
|
|
*/
|
|
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
|
/**
|
|
* Build a CfnConnection from CloudFormation properties
|
|
*
|
|
* A factory method that creates a new instance of this class from an object
|
|
* containing the CloudFormation properties of this resource.
|
|
* Used in the @aws-cdk/cloudformation-include module.
|
|
*
|
|
* @internal
|
|
*/
|
|
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnConnection;
|
|
/**
|
|
* Checks whether the given object is a CfnConnection
|
|
*/
|
|
static isCfnConnection(x: any): x is CfnConnection;
|
|
static arnForConnection(resource: IConnectionRef): string;
|
|
/**
|
|
* The name of the connection.
|
|
*/
|
|
private _connectionName;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the host associated with the connection.
|
|
*/
|
|
private _hostArn?;
|
|
/**
|
|
* The name of the external provider where your third-party code repository is configured.
|
|
*/
|
|
private _providerType?;
|
|
/**
|
|
* Tag Manager which manages the tags for this resource
|
|
*/
|
|
readonly tags: cdk.TagManager;
|
|
/**
|
|
* Specifies the tags applied to the resource.
|
|
*/
|
|
private _tagsRaw?;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::CodeStarConnections::Connection`.
|
|
*
|
|
* @param scope Scope in which this resource is defined
|
|
* @param id Construct identifier for this resource (unique in its scope)
|
|
* @param props Resource properties
|
|
*/
|
|
constructor(scope: constructs.Construct, id: string, props: CfnConnectionProps);
|
|
get connectionRef(): ConnectionReference;
|
|
/**
|
|
* The name of the connection.
|
|
*/
|
|
get connectionName(): string;
|
|
/**
|
|
* The name of the connection.
|
|
*/
|
|
set connectionName(value: string);
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the host associated with the connection.
|
|
*/
|
|
get hostArn(): string | undefined;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the host associated with the connection.
|
|
*/
|
|
set hostArn(value: string | undefined);
|
|
/**
|
|
* The name of the external provider where your third-party code repository is configured.
|
|
*/
|
|
get providerType(): string | undefined;
|
|
/**
|
|
* The name of the external provider where your third-party code repository is configured.
|
|
*/
|
|
set providerType(value: string | undefined);
|
|
/**
|
|
* Specifies the tags applied to the resource.
|
|
*/
|
|
get tagsRaw(): Array<cdk.CfnTag> | undefined;
|
|
/**
|
|
* Specifies the tags applied to the resource.
|
|
*/
|
|
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services. For example: `arn:aws:codestar-connections:us-west-2:123456789012:connection/39e4c34d-e13a-4e94-a886-ea67651bf042` .
|
|
*
|
|
* @cloudformationAttribute ConnectionArn
|
|
*/
|
|
get attrConnectionArn(): string;
|
|
/**
|
|
* The current status of the connection. For example: `PENDING` , `AVAILABLE` , or `ERROR` .
|
|
*
|
|
* @cloudformationAttribute ConnectionStatus
|
|
*/
|
|
get attrConnectionStatus(): string;
|
|
/**
|
|
* The AWS account ID of the owner of the connection. For Bitbucket, this is the account ID of the owner of the Bitbucket repository. For example: `123456789012` .
|
|
*
|
|
* @cloudformationAttribute OwnerAccountId
|
|
*/
|
|
get attrOwnerAccountId(): string;
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnConnection`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html
|
|
*/
|
|
export interface CfnConnectionProps {
|
|
/**
|
|
* The name of the connection.
|
|
*
|
|
* Connection names must be unique in an AWS account .
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-connectionname
|
|
*/
|
|
readonly connectionName: string;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the host associated with the connection.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-hostarn
|
|
*/
|
|
readonly hostArn?: string;
|
|
/**
|
|
* The name of the external provider where your third-party code repository is configured.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-providertype
|
|
*/
|
|
readonly providerType?: string;
|
|
/**
|
|
* Specifies the tags applied to the resource.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-connection.html#cfn-codestarconnections-connection-tags
|
|
*/
|
|
readonly tags?: Array<cdk.CfnTag>;
|
|
}
|
|
/**
|
|
* Information about the repository link resource, such as the repository link ARN, the associated connection ARN, encryption key ARN, and owner ID.
|
|
*
|
|
* @cloudformationResource AWS::CodeStarConnections::RepositoryLink
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html
|
|
*/
|
|
export declare class CfnRepositoryLink extends cdk.CfnResource implements cdk.IInspectable, IRepositoryLinkRef, cdk.ITaggableV2 {
|
|
/**
|
|
* The CloudFormation resource type name for this resource class.
|
|
*/
|
|
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
|
/**
|
|
* Build a CfnRepositoryLink from CloudFormation properties
|
|
*
|
|
* A factory method that creates a new instance of this class from an object
|
|
* containing the CloudFormation properties of this resource.
|
|
* Used in the @aws-cdk/cloudformation-include module.
|
|
*
|
|
* @internal
|
|
*/
|
|
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnRepositoryLink;
|
|
/**
|
|
* Checks whether the given object is a CfnRepositoryLink
|
|
*/
|
|
static isCfnRepositoryLink(x: any): x is CfnRepositoryLink;
|
|
static arnForRepositoryLink(resource: IRepositoryLinkRef): string;
|
|
/**
|
|
* Tag Manager which manages the tags for this resource
|
|
*/
|
|
readonly cdkTagManager: cdk.TagManager;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the connection associated with the repository link.
|
|
*/
|
|
private _connectionArn;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.
|
|
*/
|
|
private _encryptionKeyArn?;
|
|
/**
|
|
* The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.
|
|
*/
|
|
private _ownerId;
|
|
/**
|
|
* The name of the repository associated with the repository link.
|
|
*/
|
|
private _repositoryName;
|
|
/**
|
|
* The tags for the repository to be associated with the repository link.
|
|
*/
|
|
private _tags?;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::CodeStarConnections::RepositoryLink`.
|
|
*
|
|
* @param scope Scope in which this resource is defined
|
|
* @param id Construct identifier for this resource (unique in its scope)
|
|
* @param props Resource properties
|
|
*/
|
|
constructor(scope: constructs.Construct, id: string, props: CfnRepositoryLinkProps);
|
|
get repositoryLinkRef(): RepositoryLinkReference;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the connection associated with the repository link.
|
|
*/
|
|
get connectionArn(): string;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the connection associated with the repository link.
|
|
*/
|
|
set connectionArn(value: string);
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.
|
|
*/
|
|
get encryptionKeyArn(): string | undefined;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.
|
|
*/
|
|
set encryptionKeyArn(value: string | undefined);
|
|
/**
|
|
* The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.
|
|
*/
|
|
get ownerId(): string;
|
|
/**
|
|
* The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.
|
|
*/
|
|
set ownerId(value: string);
|
|
/**
|
|
* The name of the repository associated with the repository link.
|
|
*/
|
|
get repositoryName(): string;
|
|
/**
|
|
* The name of the repository associated with the repository link.
|
|
*/
|
|
set repositoryName(value: string);
|
|
/**
|
|
* The tags for the repository to be associated with the repository link.
|
|
*/
|
|
get tags(): Array<cdk.CfnTag> | undefined;
|
|
/**
|
|
* The tags for the repository to be associated with the repository link.
|
|
*/
|
|
set tags(value: Array<cdk.CfnTag> | undefined);
|
|
/**
|
|
* The name of the external provider where your third-party code repository is configured.
|
|
*
|
|
* @cloudformationAttribute ProviderType
|
|
*/
|
|
get attrProviderType(): string;
|
|
/**
|
|
* A unique Amazon Resource Name (ARN) to designate the repository link.
|
|
*
|
|
* @cloudformationAttribute RepositoryLinkArn
|
|
*/
|
|
get attrRepositoryLinkArn(): string;
|
|
/**
|
|
* A UUID that uniquely identifies the RepositoryLink.
|
|
*
|
|
* @cloudformationAttribute RepositoryLinkId
|
|
*/
|
|
get attrRepositoryLinkId(): string;
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnRepositoryLink`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html
|
|
*/
|
|
export interface CfnRepositoryLinkProps {
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the connection associated with the repository link.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-connectionarn
|
|
*/
|
|
readonly connectionArn: string;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-encryptionkeyarn
|
|
*/
|
|
readonly encryptionKeyArn?: string;
|
|
/**
|
|
* The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-ownerid
|
|
*/
|
|
readonly ownerId: string;
|
|
/**
|
|
* The name of the repository associated with the repository link.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-repositoryname
|
|
*/
|
|
readonly repositoryName: string;
|
|
/**
|
|
* The tags for the repository to be associated with the repository link.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-repositorylink.html#cfn-codestarconnections-repositorylink-tags
|
|
*/
|
|
readonly tags?: Array<cdk.CfnTag>;
|
|
}
|
|
/**
|
|
* Information, such as repository, branch, provider, and resource names for a specific sync configuration.
|
|
*
|
|
* @cloudformationResource AWS::CodeStarConnections::SyncConfiguration
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html
|
|
*/
|
|
export declare class CfnSyncConfiguration extends cdk.CfnResource implements cdk.IInspectable, ISyncConfigurationRef {
|
|
/**
|
|
* The CloudFormation resource type name for this resource class.
|
|
*/
|
|
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
|
/**
|
|
* Build a CfnSyncConfiguration from CloudFormation properties
|
|
*
|
|
* A factory method that creates a new instance of this class from an object
|
|
* containing the CloudFormation properties of this resource.
|
|
* Used in the @aws-cdk/cloudformation-include module.
|
|
*
|
|
* @internal
|
|
*/
|
|
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSyncConfiguration;
|
|
/**
|
|
* Checks whether the given object is a CfnSyncConfiguration
|
|
*/
|
|
static isCfnSyncConfiguration(x: any): x is CfnSyncConfiguration;
|
|
/**
|
|
* The branch associated with a specific sync configuration.
|
|
*/
|
|
private _branch;
|
|
/**
|
|
* The file path to the configuration file associated with a specific sync configuration.
|
|
*/
|
|
private _configFile;
|
|
/**
|
|
* Whether to enable or disable publishing of deployment status to source providers.
|
|
*/
|
|
private _publishDeploymentStatus?;
|
|
/**
|
|
* The ID of the repository link associated with a specific sync configuration.
|
|
*/
|
|
private _repositoryLinkId;
|
|
/**
|
|
* The name of the connection resource associated with a specific sync configuration.
|
|
*/
|
|
private _resourceName;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
|
|
*/
|
|
private _roleArn;
|
|
/**
|
|
* The type of sync for a specific sync configuration.
|
|
*/
|
|
private _syncType;
|
|
/**
|
|
* When to trigger Git sync to begin the stack update.
|
|
*/
|
|
private _triggerResourceUpdateOn?;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::CodeStarConnections::SyncConfiguration`.
|
|
*
|
|
* @param scope Scope in which this resource is defined
|
|
* @param id Construct identifier for this resource (unique in its scope)
|
|
* @param props Resource properties
|
|
*/
|
|
constructor(scope: constructs.Construct, id: string, props: CfnSyncConfigurationProps);
|
|
get syncConfigurationRef(): SyncConfigurationReference;
|
|
/**
|
|
* The branch associated with a specific sync configuration.
|
|
*/
|
|
get branch(): string;
|
|
/**
|
|
* The branch associated with a specific sync configuration.
|
|
*/
|
|
set branch(value: string);
|
|
/**
|
|
* The file path to the configuration file associated with a specific sync configuration.
|
|
*/
|
|
get configFile(): string;
|
|
/**
|
|
* The file path to the configuration file associated with a specific sync configuration.
|
|
*/
|
|
set configFile(value: string);
|
|
/**
|
|
* Whether to enable or disable publishing of deployment status to source providers.
|
|
*/
|
|
get publishDeploymentStatus(): string | undefined;
|
|
/**
|
|
* Whether to enable or disable publishing of deployment status to source providers.
|
|
*/
|
|
set publishDeploymentStatus(value: string | undefined);
|
|
/**
|
|
* The ID of the repository link associated with a specific sync configuration.
|
|
*/
|
|
get repositoryLinkId(): string;
|
|
/**
|
|
* The ID of the repository link associated with a specific sync configuration.
|
|
*/
|
|
set repositoryLinkId(value: string);
|
|
/**
|
|
* The name of the connection resource associated with a specific sync configuration.
|
|
*/
|
|
get resourceName(): string;
|
|
/**
|
|
* The name of the connection resource associated with a specific sync configuration.
|
|
*/
|
|
set resourceName(value: string);
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
|
|
*/
|
|
get roleArn(): string;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
|
|
*/
|
|
set roleArn(value: string);
|
|
/**
|
|
* The type of sync for a specific sync configuration.
|
|
*/
|
|
get syncType(): string;
|
|
/**
|
|
* The type of sync for a specific sync configuration.
|
|
*/
|
|
set syncType(value: string);
|
|
/**
|
|
* When to trigger Git sync to begin the stack update.
|
|
*/
|
|
get triggerResourceUpdateOn(): string | undefined;
|
|
/**
|
|
* When to trigger Git sync to begin the stack update.
|
|
*/
|
|
set triggerResourceUpdateOn(value: string | undefined);
|
|
/**
|
|
* The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.
|
|
*
|
|
* @cloudformationAttribute OwnerId
|
|
*/
|
|
get attrOwnerId(): string;
|
|
/**
|
|
* The name of the external provider where your third-party code repository is configured.
|
|
*
|
|
* @cloudformationAttribute ProviderType
|
|
*/
|
|
get attrProviderType(): string;
|
|
/**
|
|
* The name of the repository that is being synced to.
|
|
*
|
|
* @cloudformationAttribute RepositoryName
|
|
*/
|
|
get attrRepositoryName(): string;
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnSyncConfiguration`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html
|
|
*/
|
|
export interface CfnSyncConfigurationProps {
|
|
/**
|
|
* The branch associated with a specific sync configuration.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-branch
|
|
*/
|
|
readonly branch: 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.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-configfile
|
|
*/
|
|
readonly configFile: string;
|
|
/**
|
|
* Whether to enable or disable publishing of deployment status to source providers.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-publishdeploymentstatus
|
|
*/
|
|
readonly publishDeploymentStatus?: string;
|
|
/**
|
|
* The ID of the repository link associated with a specific sync configuration.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-repositorylinkid
|
|
*/
|
|
readonly repositoryLinkId: string;
|
|
/**
|
|
* The name of the connection resource associated with a specific sync configuration.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-resourcename
|
|
*/
|
|
readonly resourceName: string;
|
|
/**
|
|
* The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-rolearn
|
|
*/
|
|
readonly roleArn: string;
|
|
/**
|
|
* The type of sync for a specific sync configuration.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-synctype
|
|
*/
|
|
readonly syncType: string;
|
|
/**
|
|
* When to trigger Git sync to begin the stack update.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestarconnections-syncconfiguration.html#cfn-codestarconnections-syncconfiguration-triggerresourceupdateon
|
|
*/
|
|
readonly triggerResourceUpdateOn?: string;
|
|
}
|
|
export type { IConnectionRef, ConnectionReference };
|
|
export type { IRepositoryLinkRef, RepositoryLinkReference };
|
|
export type { ISyncConfigurationRef, SyncConfigurationReference };
|