Package software.amazon.awscdk.services.codeartifact

Class CfnPackageGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.codeartifact.CfnPackageGroup
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:15.907Z") @Stability(Stable) public class CfnPackageGroup extends CfnResource implements IInspectable, ITaggableV2
Creates a package group.

For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide .

Example: 

 // 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.*;
 CfnPackageGroup cfnPackageGroup = CfnPackageGroup.Builder.create(this, "MyCfnPackageGroup")
         .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPackageGroup

      protected CfnPackageGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPackageGroup

      protected CfnPackageGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPackageGroup

      @Stability(Stable) public CfnPackageGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPackageGroupProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the package group.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The domain that contains the package group.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The domain that contains the package group.

    • getPattern

      @Stability(Stable) @NotNull public String getPattern()
      The pattern of the package group.

    • setPattern

      @Stability(Stable) public void setPattern(@NotNull String value)
      The pattern of the package group.

    • getContactInfo

      @Stability(Stable) @Nullable public String getContactInfo()
      The contact information of the package group.

    • setContactInfo

      @Stability(Stable) public void setContactInfo(@Nullable String value)
      The contact information of the package group.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the package group.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the package group.

    • getDomainOwner

      @Stability(Stable) @Nullable public String getDomainOwner()
      The 12-digit account number of the AWS account that owns the domain.

    • setDomainOwner

      @Stability(Stable) public void setDomainOwner(@Nullable String value)
      The 12-digit account number of the AWS account that owns the domain.

    • getOriginConfiguration

      @Stability(Stable) @Nullable public Object getOriginConfiguration()
      Details about the package origin configuration of a package group.

    • setOriginConfiguration

      @Stability(Stable) public void setOriginConfiguration(@Nullable IResolvable value)
      Details about the package origin configuration of a package group.

    • setOriginConfiguration

      @Stability(Stable) public void setOriginConfiguration(@Nullable CfnPackageGroup.OriginConfigurationProperty value)
      Details about the package origin configuration of a package group.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags to be applied to the package group.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags to be applied to the package group.