UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

302 lines (301 loc) 14.3 kB
import * as constructs from 'constructs'; import * as cdk from '../../core'; import * as cfn_parse from '../../core/lib/helpers-internal'; /** * Properties for defining a `CfnDomain` * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html */ export interface CfnDomainProps { /** * A string that specifies the name of the requested domain. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-domainname */ readonly domainName: string; /** * The key used to encrypt the domain. * * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-encryptionkey */ readonly encryptionKey?: string; /** * The document that defines the resource policy that is set on a domain. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-permissionspolicydocument */ readonly permissionsPolicyDocument?: any | cdk.IResolvable; /** * A list of tags to be applied to the domain. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-tags */ readonly tags?: cdk.CfnTag[]; } /** * A CloudFormation `AWS::CodeArtifact::Domain` * * The `AWS::CodeArtifact::Domain` resource creates an AWS CodeArtifact domain. CodeArtifact *domains* make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different AWS accounts. For more information about domains, see the [Domain concepts information](https://docs.aws.amazon.com/codeartifact/latest/ug/codeartifact-concepts.html#welcome-concepts-domain) in the *CodeArtifact User Guide* . For more information about the `CreateDomain` API, see [CreateDomain](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateDomain.html) in the *CodeArtifact API Reference* . * * @cloudformationResource AWS::CodeArtifact::Domain * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html */ export declare class CfnDomain extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CodeArtifact::Domain"; /** * 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): CfnDomain; /** * When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the domain. * @cloudformationAttribute Arn */ readonly attrArn: string; /** * When you pass the logical ID of this resource, the function returns the key used to encrypt the domain. * @cloudformationAttribute EncryptionKey */ readonly attrEncryptionKey: string; /** * When you pass the logical ID of this resource, the function returns the name of the domain. * @cloudformationAttribute Name */ readonly attrName: string; /** * When you pass the logical ID of this resource, the function returns the 12-digit account number of the AWS account that owns the domain. * @cloudformationAttribute Owner */ readonly attrOwner: string; /** * A string that specifies the name of the requested domain. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-domainname */ domainName: string; /** * The key used to encrypt the domain. * * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-encryptionkey */ encryptionKey: string | undefined; /** * The document that defines the resource policy that is set on a domain. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-permissionspolicydocument */ permissionsPolicyDocument: any | cdk.IResolvable | undefined; /** * A list of tags to be applied to the domain. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-tags */ readonly tags: cdk.TagManager; /** * Create a new `AWS::CodeArtifact::Domain`. * * @param scope - scope in which this resource is defined * @param id - scoped id of the resource * @param props - resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnDomainProps); /** * Examines the CloudFormation resource and discloses attributes. * * @param inspector - tree inspector to collect and process attributes * */ inspect(inspector: cdk.TreeInspector): void; protected get cfnProperties(): { [key: string]: any; }; protected renderProperties(props: { [key: string]: any; }): { [key: string]: any; }; } /** * Properties for defining a `CfnRepository` * * @struct * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html */ export interface CfnRepositoryProps { /** * The name of the domain that contains the repository. * * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainname */ readonly domainName: string; /** * The name of an upstream repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-repositoryname */ readonly repositoryName: string; /** * A text description of the repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-description */ readonly description?: string; /** * The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces. * * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainowner */ readonly domainOwner?: string; /** * An array of external connections associated with the repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-externalconnections */ readonly externalConnections?: string[]; /** * The document that defines the resource policy that is set on a repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-permissionspolicydocument */ readonly permissionsPolicyDocument?: any | cdk.IResolvable; /** * A list of tags to be applied to the repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-tags */ readonly tags?: cdk.CfnTag[]; /** * A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see [Working with upstream repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html) . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-upstreams */ readonly upstreams?: string[]; } /** * A CloudFormation `AWS::CodeArtifact::Repository` * * The `AWS::CodeArtifact::Repository` resource creates an AWS CodeArtifact repository. CodeArtifact *repositories* contain a set of package versions. For more information about repositories, see the [Repository concepts information](https://docs.aws.amazon.com/codeartifact/latest/ug/codeartifact-concepts.html#welcome-concepts-repository) in the *CodeArtifact User Guide* . For more information about the `CreateRepository` API, see [CreateRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html) in the *CodeArtifact API Reference* . * * @cloudformationResource AWS::CodeArtifact::Repository * @stability external * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html */ export declare class CfnRepository extends cdk.CfnResource implements cdk.IInspectable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CodeArtifact::Repository"; /** * 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): CfnRepository; /** * When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository. * @cloudformationAttribute Arn */ readonly attrArn: string; /** * When you pass the logical ID of this resource, the function returns the domain name that contains the repository. * @cloudformationAttribute DomainName */ readonly attrDomainName: string; /** * When you pass the logical ID of this resource, the function returns the 12-digit account number of the AWS account that owns the domain that contains the repository. * @cloudformationAttribute DomainOwner */ readonly attrDomainOwner: string; /** * When you pass the logical ID of this resource, the function returns the name of the repository. * @cloudformationAttribute Name */ readonly attrName: string; /** * The name of the domain that contains the repository. * * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainname */ domainName: string; /** * The name of an upstream repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-repositoryname */ repositoryName: string; /** * A text description of the repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-description */ description: string | undefined; /** * The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces. * * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainowner */ domainOwner: string | undefined; /** * An array of external connections associated with the repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-externalconnections */ externalConnections: string[] | undefined; /** * The document that defines the resource policy that is set on a repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-permissionspolicydocument */ permissionsPolicyDocument: any | cdk.IResolvable | undefined; /** * A list of tags to be applied to the repository. * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-tags */ readonly tags: cdk.TagManager; /** * A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see [Working with upstream repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html) . * * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-upstreams */ upstreams: string[] | undefined; /** * Create a new `AWS::CodeArtifact::Repository`. * * @param scope - scope in which this resource is defined * @param id - scoped id of the resource * @param props - resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnRepositoryProps); /** * Examines the CloudFormation resource and discloses attributes. * * @param inspector - tree inspector to collect and process attributes * */ inspect(inspector: cdk.TreeInspector): void; protected get cfnProperties(): { [key: string]: any; }; protected renderProperties(props: { [key: string]: any; }): { [key: string]: any; }; }