package_groups

Creates, updates, deletes or gets a package_group resource or lists package_groups in a region

Overview

Name	package_groups
Type	Resource
Description	The resource schema to create a CodeArtifact package group.
Id	aws.codeartifact.package_groups

Fields

Name	Datatype	Description
domain_name	string	The name of the domain that contains the package group.
domain_owner	string	The 12-digit account ID of the AWS account that owns the domain.
pattern	string	The package group pattern that is used to gather packages.
contact_info	string	The contact info of the package group.
description	string	The text description of the package group.
origin_configuration	object	The package origin configuration of the package group.
tags	array	An array of key-value pairs to apply to the package group.
arn	string	The ARN of the package group.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Pattern, 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 package_groups in a region.

SELECT
region,
domain_name,
domain_owner,
pattern,
contact_info,
description,
origin_configuration,
tags,
arn
FROM aws.codeartifact.package_groups
WHERE region = 'us-east-1';

Gets all properties from an individual package_group.

SELECT
region,
domain_name,
domain_owner,
pattern,
contact_info,
description,
origin_configuration,
tags,
arn
FROM aws.codeartifact.package_groups
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.codeartifact.package_groups (
 DomainName,
 DomainOwner,
 Pattern,
 ContactInfo,
 Description,
 OriginConfiguration,
 Tags,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ DomainOwner }}',
 '{{ Pattern }}',
 '{{ ContactInfo }}',
 '{{ Description }}',
 '{{ OriginConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: package_group
    props:
      - name: DomainName
        value: '{{ DomainName }}'
      - name: DomainOwner
        value: '{{ DomainOwner }}'
      - name: Pattern
        value: '{{ Pattern }}'
      - name: ContactInfo
        value: '{{ ContactInfo }}'
      - name: Description
        value: '{{ Description }}'
      - name: OriginConfiguration
        value:
          Restrictions:
            Publish:
              RestrictionMode: '{{ RestrictionMode }}'
              Repositories:
                - '{{ Repositories[0] }}'
            ExternalUpstream: null
            InternalUpstream: null
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

codeartifact:CreatePackageGroup,
codeartifact:DescribePackageGroup,
codeartifact:UpdatePackageGroup,
codeartifact:UpdatePackageGroupOriginConfiguration,
codeartifact:ListAllowedRepositoriesForGroup,
codeartifact:ListTagsForResource,
codeartifact:TagResource

Read

codeartifact:DescribePackageGroup,
codeartifact:ListAllowedRepositoriesForGroup,
codeartifact:ListTagsForResource

Update

codeartifact:UpdatePackageGroup,
codeartifact:UpdatePackageGroupOriginConfiguration,
codeartifact:DescribePackageGroup,
codeartifact:ListAllowedRepositoriesForGroup,
codeartifact:ListTagsForResource,
codeartifact:TagResource,
codeartifact:UntagResource

Delete

codeartifact:DeletePackageGroup,
codeartifact:DescribePackageGroup

List

codeartifact:ListPackageGroups