domains

Creates, updates, deletes or gets a domain resource or lists domains in a region

Overview

Name	domains
Type	Resource
Description	The resource schema to create a CodeArtifact domain.
Id	aws.codeartifact.domains

Fields

Name	Datatype	Description
domain_name	string	The name of the domain.
name	string	The name of the domain. This field is used for GetAtt
owner	string	The 12-digit account ID of the AWS account that owns the domain. This field is used for GetAtt
encryption_key	string	The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.
permissions_policy_document	object	The access control resource policy on the provided domain.
tags	array	An array of key-value pairs to apply to this resource.
arn	string	The ARN of the domain.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all domains in a region.

SELECT
region,
domain_name,
name,
owner,
encryption_key,
permissions_policy_document,
tags,
arn
FROM aws.codeartifact.domains
WHERE region = 'us-east-1';

Gets all properties from an individual domain.

SELECT
region,
domain_name,
name,
owner,
encryption_key,
permissions_policy_document,
tags,
arn
FROM aws.codeartifact.domains
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new domain resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.codeartifact.domains (
 DomainName,
 region
)
SELECT 
'{{ DomainName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.codeartifact.domains (
 DomainName,
 PermissionsPolicyDocument,
 Tags,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ PermissionsPolicyDocument }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: domain
    props:
      - name: DomainName
        value: '{{ DomainName }}'
      - name: PermissionsPolicyDocument
        value: {}
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.codeartifact.domains
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the domains resource, the following permissions are required:

Create

codeartifact:CreateDomain,
codeartifact:DescribeDomain,
codeartifact:PutDomainPermissionsPolicy,
codeartifact:GetDomainPermissionsPolicy,
codeartifact:TagResource

Read

codeartifact:DescribeDomain,
codeartifact:GetDomainPermissionsPolicy,
codeartifact:ListTagsForResource

Update

codeartifact:PutDomainPermissionsPolicy,
codeartifact:DeleteDomainPermissionsPolicy,
codeartifact:GetDomainPermissionsPolicy,
codeartifact:TagResource,
codeartifact:UntagResource

Delete

codeartifact:DeleteDomain,
codeartifact:DescribeDomain

List

codeartifact:ListDomains