Skip to content
v2.277.0

CfnPackageGroupProps Struct ​

Properties for defining a CfnPackageGroup.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codeartifact as codeartifact } from 'aws-cdk-lib';
const cfnPackageGroupProps: codeartifact.CfnPackageGroupProps = {
  domainName: 'domainName',
  pattern: 'pattern',

  // the properties below are optional
  contactInfo: 'contactInfo',
  description: 'description',
  domainOwner: 'domainOwner',
  originConfiguration: {
    restrictions: {
      externalUpstream: {
        restrictionMode: 'restrictionMode',

        // the properties below are optional
        repositories: ['repositories'],
      },
      internalUpstream: {
        restrictionMode: 'restrictionMode',

        // the properties below are optional
        repositories: ['repositories'],
      },
      publish: {
        restrictionMode: 'restrictionMode',

        // the properties below are optional
        repositories: ['repositories'],
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codeartifact as codeartifact

cfn_package_group_props = codeartifact.CfnPackageGroupProps(
    domain_name="domainName",
    pattern="pattern",

    # the properties below are optional
    contact_info="contactInfo",
    description="description",
    domain_owner="domainOwner",
    origin_configuration=codeartifact.CfnPackageGroup.OriginConfigurationProperty(
        restrictions=codeartifact.CfnPackageGroup.RestrictionsProperty(
            external_upstream=codeartifact.CfnPackageGroup.RestrictionTypeProperty(
                restriction_mode="restrictionMode",

                # the properties below are optional
                repositories=["repositories"]
            ),
            internal_upstream=codeartifact.CfnPackageGroup.RestrictionTypeProperty(
                restriction_mode="restrictionMode",

                # the properties below are optional
                repositories=["repositories"]
            ),
            publish=codeartifact.CfnPackageGroup.RestrictionTypeProperty(
                restriction_mode="restrictionMode",

                # the properties below are optional
                repositories=["repositories"]
            )
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codeartifact.*;

CfnPackageGroupProps cfnPackageGroupProps = CfnPackageGroupProps.builder()
        .domainName("domainName")
        .pattern("pattern")

        // the properties below are optional
        .contactInfo("contactInfo")
        .description("description")
        .domainOwner("domainOwner")
        .originConfiguration(OriginConfigurationProperty.builder()
                .restrictions(RestrictionsProperty.builder()
                        .externalUpstream(RestrictionTypeProperty.builder()
                                .restrictionMode("restrictionMode")

                                // the properties below are optional
                                .repositories(List.of("repositories"))
                                .build())
                        .internalUpstream(RestrictionTypeProperty.builder()
                                .restrictionMode("restrictionMode")

                                // the properties below are optional
                                .repositories(List.of("repositories"))
                                .build())
                        .publish(RestrictionTypeProperty.builder()
                                .restrictionMode("restrictionMode")

                                // the properties below are optional
                                .repositories(List.of("repositories"))
                                .build())
                        .build())
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeArtifact;

var cfnPackageGroupProps = new CfnPackageGroupProps {
    DomainName = "domainName",
    Pattern = "pattern",

    // the properties below are optional
    ContactInfo = "contactInfo",
    Description = "description",
    DomainOwner = "domainOwner",
    OriginConfiguration = new OriginConfigurationProperty {
        Restrictions = new RestrictionsProperty {
            ExternalUpstream = new RestrictionTypeProperty {
                RestrictionMode = "restrictionMode",

                // the properties below are optional
                Repositories = new [] { "repositories" }
            },
            InternalUpstream = new RestrictionTypeProperty {
                RestrictionMode = "restrictionMode",

                // the properties below are optional
                Repositories = new [] { "repositories" }
            },
            Publish = new RestrictionTypeProperty {
                RestrictionMode = "restrictionMode",

                // the properties below are optional
                Repositories = new [] { "repositories" }
            }
        }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnPackageGroupProps := &CfnPackageGroupProps{
	DomainName: jsii.String("domainName"),
	Pattern: jsii.String("pattern"),

	// the properties below are optional
	ContactInfo: jsii.String("contactInfo"),
	Description: jsii.String("description"),
	DomainOwner: jsii.String("domainOwner"),
	OriginConfiguration: &OriginConfigurationProperty{
		Restrictions: &RestrictionsProperty{
			ExternalUpstream: &RestrictionTypeProperty{
				RestrictionMode: jsii.String("restrictionMode"),

				// the properties below are optional
				Repositories: []*string{
					jsii.String("repositories"),
				},
			},
			InternalUpstream: &RestrictionTypeProperty{
				RestrictionMode: jsii.String("restrictionMode"),

				// the properties below are optional
				Repositories: []*string{
					jsii.String("repositories"),
				},
			},
			Publish: &RestrictionTypeProperty{
				RestrictionMode: jsii.String("restrictionMode"),

				// the properties below are optional
				Repositories: []*string{
					jsii.String("repositories"),
				},
			},
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

contactInfooptionalstringcontact_infooptionalstrcontactInfooptionalStringContactInfooptionalstringContactInfooptional*string #
The contact information of the package group.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
The description of the package group.
domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string required #
The domain that contains the package group.
domainOwneroptionalstringdomain_owneroptionalstrdomainOwneroptionalStringDomainOwneroptionalstringDomainOwneroptional*string #
The 12-digit account number of the AWS account that owns the domain.

It does not include dashes or spaces.

originConfigurationoptionalIResolvable | CfnPackageGroup.OriginConfigurationPropertyorigin_configurationoptionaltyping.Union[IResolvable, OriginConfigurationProperty]originConfigurationoptionalIResolvableOriginConfigurationoptionalIResolvableOriginConfigurationoptionalinterface{} #
Details about the package origin configuration of a package group.
patternstringpatternstrpatternStringPatternstringPattern*string required #
The pattern of the package group.

The pattern determines which packages are associated with the package group.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
An array of key-value pairs to apply to the package group.