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	awscc.codeartifact.package_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The ARN of the package group.
region	string	AWS region.

For more information, see AWS::CodeArtifact::PackageGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	package_groups	INSERT	Pattern, DomainName, region
delete_resource	package_groups	DELETE	Identifier, region
update_resource	package_groups	UPDATE	Identifier, PatchDocument, region
list_resources	package_groups_list_only	SELECT	region
get_resource	package_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual package_group.

SELECT
  region,
  domain_name,
  domain_owner,
  pattern,
  contact_info,
  description,
  origin_configuration,
  tags,
  arn
FROM awscc.codeartifact.package_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all package_groups in a region.

SELECT
  region,
  arn
FROM awscc.codeartifact.package_groups_list_only
WHERE
  region = 'us-east-1';

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 awscc.codeartifact.package_groups (
  DomainName,
  Pattern,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ pattern }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.codeartifact.package_groups (
  DomainName,
  DomainOwner,
  Pattern,
  ContactInfo,
  Description,
  OriginConfiguration,
  Tags,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ domain_owner }}',
  '{{ pattern }}',
  '{{ contact_info }}',
  '{{ description }}',
  '{{ origin_configuration }}',
  '{{ 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: domain_name
        value: '{{ domain_name }}'
      - name: domain_owner
        value: '{{ domain_owner }}'
      - name: pattern
        value: '{{ pattern }}'
      - name: contact_info
        value: '{{ contact_info }}'
      - name: description
        value: '{{ description }}'
      - name: origin_configuration
        value:
          restrictions:
            publish:
              restriction_mode: '{{ restriction_mode }}'
              repositories:
                - '{{ repositories[0] }}'
            external_upstream: null
            internal_upstream: null
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.codeartifact.package_groups
SET PatchDocument = string('{{ {
    "DomainOwner": domain_owner,
    "ContactInfo": contact_info,
    "Description": description,
    "OriginConfiguration": origin_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.codeartifact.package_groups
WHERE
  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