{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/core": "1.204.0" }, "dependencyClosure": { "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::CodeArtifact", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "experimental" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "AWS::CodeArtifact", "aws-codeartifact" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-codeartifact", "readme": { "markdown": "# AWS::CodeArtifact Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\n---\n\n\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n```ts nofixture\nimport * as codeartifact from '@aws-cdk/aws-codeartifact';\n```\n\n\n\nThere are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:\n\n- Search [Construct Hub for CodeArtifact construct libraries](https://constructs.dev/search?q=codeartifact)\n- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::CodeArtifact resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_CodeArtifact.html) directly.\n\n\n\n\nThere are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.\nHowever, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.\n\nFor more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::CodeArtifact](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_CodeArtifact.html).\n\n(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)\n\n\n" }, "repository": { "directory": "packages/@aws-cdk/aws-codeartifact", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeArtifact", "packageId": "Amazon.CDK.AWS.CodeArtifact" }, "java": { "maven": { "artifactId": "codeartifact", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codeartifact" }, "js": { "npm": "@aws-cdk/aws-codeartifact" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codeartifact", "module": "aws_cdk.aws_codeartifact" } }, "types": { "@aws-cdk/aws-codeartifact.CfnDomain": { "assembly": "@aws-cdk/aws-codeartifact", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CodeArtifact::Domain", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .", "stability": "external", "summary": "A CloudFormation `AWS::CodeArtifact::Domain`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as codeartifact from '@aws-cdk/aws-codeartifact';\n\ndeclare const permissionsPolicyDocument: any;\nconst cfnDomain = new codeartifact.CfnDomain(this, 'MyCfnDomain', {\n domainName: 'domainName',\n\n // the properties below are optional\n encryptionKey: 'encryptionKey',\n permissionsPolicyDocument: permissionsPolicyDocument,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-codeartifact.CfnDomain", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CodeArtifact::Domain`." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 199 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-codeartifact.CfnDomainProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 115 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 219 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 233 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDomain", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 119 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 144 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "EncryptionKey" }, "stability": "external", "summary": "When you pass the logical ID of this resource, the function returns the key used to encrypt the domain." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 150 }, "name": "attrEncryptionKey", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "When you pass the logical ID of this resource, the function returns the name of the domain." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 156 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Owner" }, "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 162 }, "name": "attrOwner", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 224 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-tags" }, "stability": "external", "summary": "A list of tags to be applied to the domain." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 190 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-domainname" }, "stability": "external", "summary": "A string that specifies the name of the requested domain." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 169 }, "name": "domainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-permissionspolicydocument" }, "stability": "external", "summary": "The document that defines the resource policy that is set on a domain." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 183 }, "name": "permissionsPolicyDocument", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-encryptionkey" }, "stability": "external", "summary": "The key used to encrypt the domain." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 176 }, "name": "encryptionKey", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/codeartifact.generated:CfnDomain" }, "@aws-cdk/aws-codeartifact.CfnDomainProps": { "assembly": "@aws-cdk/aws-codeartifact", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDomain`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as codeartifact from '@aws-cdk/aws-codeartifact';\n\ndeclare const permissionsPolicyDocument: any;\nconst cfnDomainProps: codeartifact.CfnDomainProps = {\n domainName: 'domainName',\n\n // the properties below are optional\n encryptionKey: 'encryptionKey',\n permissionsPolicyDocument: permissionsPolicyDocument,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-codeartifact.CfnDomainProps", "kind": "interface", "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 19 }, "name": "CfnDomainProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-domainname" }, "stability": "external", "summary": "A string that specifies the name of the requested domain." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 26 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-encryptionkey" }, "stability": "external", "summary": "The key used to encrypt the domain." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 33 }, "name": "encryptionKey", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-permissionspolicydocument" }, "stability": "external", "summary": "The document that defines the resource policy that is set on a domain." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 40 }, "name": "permissionsPolicyDocument", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-domain.html#cfn-codeartifact-domain-tags" }, "stability": "external", "summary": "A list of tags to be applied to the domain." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 47 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/codeartifact.generated:CfnDomainProps" }, "@aws-cdk/aws-codeartifact.CfnRepository": { "assembly": "@aws-cdk/aws-codeartifact", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::CodeArtifact::Repository", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html", "exampleMetadata": "fixture=_generated" }, "remarks": "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* .", "stability": "external", "summary": "A CloudFormation `AWS::CodeArtifact::Repository`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as codeartifact from '@aws-cdk/aws-codeartifact';\n\ndeclare const permissionsPolicyDocument: any;\nconst cfnRepository = new codeartifact.CfnRepository(this, 'MyCfnRepository', {\n domainName: 'domainName',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n description: 'description',\n domainOwner: 'domainOwner',\n externalConnections: ['externalConnections'],\n permissionsPolicyDocument: permissionsPolicyDocument,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n upstreams: ['upstreams'],\n});" }, "fqn": "@aws-cdk/aws-codeartifact.CfnRepository", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::CodeArtifact::Repository`." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 495 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-codeartifact.CfnRepositoryProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 383 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 520 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 538 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnRepository", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 387 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external", "summary": "When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 412 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DomainName" }, "stability": "external", "summary": "When you pass the logical ID of this resource, the function returns the domain name that contains the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 418 }, "name": "attrDomainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DomainOwner" }, "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 424 }, "name": "attrDomainOwner", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Name" }, "stability": "external", "summary": "When you pass the logical ID of this resource, the function returns the name of the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 430 }, "name": "attrName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 525 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-tags" }, "stability": "external", "summary": "A list of tags to be applied to the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 479 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainname" }, "stability": "external", "summary": "The name of the domain that contains the repository." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 437 }, "name": "domainName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-permissionspolicydocument" }, "stability": "external", "summary": "The document that defines the resource policy that is set on a repository." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 472 }, "name": "permissionsPolicyDocument", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-repositoryname" }, "stability": "external", "summary": "The name of an upstream repository." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 444 }, "name": "repositoryName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-description" }, "stability": "external", "summary": "A text description of the repository." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 451 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainowner" }, "remarks": "It does not include dashes or spaces.", "stability": "external", "summary": "The 12-digit account number of the AWS account that owns the domain that contains the repository." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 458 }, "name": "domainOwner", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-externalconnections" }, "stability": "external", "summary": "An array of external connections associated with the repository." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 465 }, "name": "externalConnections", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-upstreams" }, "remarks": "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) .", "stability": "external", "summary": "A list of upstream repositories to associate with the repository." }, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 486 }, "name": "upstreams", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/codeartifact.generated:CfnRepository" }, "@aws-cdk/aws-codeartifact.CfnRepositoryProps": { "assembly": "@aws-cdk/aws-codeartifact", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnRepository`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as codeartifact from '@aws-cdk/aws-codeartifact';\n\ndeclare const permissionsPolicyDocument: any;\nconst cfnRepositoryProps: codeartifact.CfnRepositoryProps = {\n domainName: 'domainName',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n description: 'description',\n domainOwner: 'domainOwner',\n externalConnections: ['externalConnections'],\n permissionsPolicyDocument: permissionsPolicyDocument,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n upstreams: ['upstreams'],\n};" }, "fqn": "@aws-cdk/aws-codeartifact.CfnRepositoryProps", "kind": "interface", "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 246 }, "name": "CfnRepositoryProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainname" }, "stability": "external", "summary": "The name of the domain that contains the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 253 }, "name": "domainName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-repositoryname" }, "stability": "external", "summary": "The name of an upstream repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 260 }, "name": "repositoryName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-description" }, "stability": "external", "summary": "A text description of the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 267 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-domainowner" }, "remarks": "It does not include dashes or spaces.", "stability": "external", "summary": "The 12-digit account number of the AWS account that owns the domain that contains the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 274 }, "name": "domainOwner", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-externalconnections" }, "stability": "external", "summary": "An array of external connections associated with the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 281 }, "name": "externalConnections", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-permissionspolicydocument" }, "stability": "external", "summary": "The document that defines the resource policy that is set on a repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 288 }, "name": "permissionsPolicyDocument", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-tags" }, "stability": "external", "summary": "A list of tags to be applied to the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 295 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-repository.html#cfn-codeartifact-repository-upstreams" }, "remarks": "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) .", "stability": "external", "summary": "A list of upstream repositories to associate with the repository." }, "immutable": true, "locationInModule": { "filename": "lib/codeartifact.generated.ts", "line": 302 }, "name": "upstreams", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/codeartifact.generated:CfnRepositoryProps" } }, "version": "1.204.0", "fingerprint": "**********" }