Amazon CodeArtifact · JSON Structure

Codeartifact Create Domain Request Structure

CreateDomainRequest schema from Amazon CodeArtifact API

Type: object Properties: 2
AmazonArtifact RepositoryPackage ManagementDevOpsSoftware Supply ChainnpmMavenPyPINuGet

CreateDomainRequest is a JSON Structure definition published by Amazon CodeArtifact, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

encryptionKey tags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeartifact/refs/heads/main/json-structure/codeartifact-create-domain-request-structure.json",
  "name": "CreateDomainRequest",
  "description": "CreateDomainRequest schema from Amazon CodeArtifact API",
  "type": "object",
  "properties": {
    "encryptionKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "<p> The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an <code>encryptionKey</code>, your IAM role must have <code>kms:DescribeKey</code> and <code>kms:CreateGrant</code> permissions on the encryption key that is used. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax\">DescribeKey</a> in the <i>Key Management Service API Reference</i> and <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html\">Key Management Service API Permissions Reference</a> in the <i>Key Management Service Developer Guide</i>. </p> <important> <p> CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer Guide</i>. </p> </important>"
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "One or more tag key-value pairs for the domain."
        }
      ]
    }
  }
}