CfnPackageGroup

class aws_cdk.aws_codeartifact.CfnPackageGroup(scope, id, *, domain_name, pattern, contact_info=None, description=None, domain_owner=None, origin_configuration=None, tags=None)

Bases: CfnResource

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codeartifact-packagegroup.html

CloudformationResource:

AWS::CodeArtifact::PackageGroup

ExampleMetadata:

fixture=_generated

Example:

# 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 = codeartifact.CfnPackageGroup(self, "MyCfnPackageGroup",
    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"
    )]
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • domain_name (str) – The domain that contains the package group.

  • pattern (str) – The pattern of the package group. The pattern determines which packages are associated with the package group.

  • contact_info (Optional[str]) – The contact information of the package group.

  • description (Optional[str]) – The description of the package group.

  • domain_owner (Optional[str]) – The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

  • origin_configuration (Union[IResolvable, OriginConfigurationProperty, Dict[str, Any], None]) – Details about the package origin configuration of a package group.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags to be applied to the package group.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CodeArtifact::PackageGroup'
attr_arn

When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the package group.

CloudformationAttribute:

Arn

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

contact_info

The contact information of the package group.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The description of the package group.

domain_name

The domain that contains the package group.

domain_owner

The 12-digit account number of the AWS account that owns the domain.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

origin_configuration

Details about the package origin configuration of a package group.

pattern

The pattern of the package group.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

A list of tags to be applied to the package group.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

OriginConfigurationProperty

class CfnPackageGroup.OriginConfigurationProperty(*, restrictions)

Bases: object

The package group origin configuration that determines how package versions can enter repositories.

Parameters:

restrictions (Union[IResolvable, RestrictionsProperty, Dict[str, Any]]) – The origin configuration settings that determine how package versions can enter repositories.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-originconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# 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

origin_configuration_property = 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"]
        )
    )
)

Attributes

restrictions

The origin configuration settings that determine how package versions can enter repositories.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-originconfiguration.html#cfn-codeartifact-packagegroup-originconfiguration-restrictions

RestrictionTypeProperty

class CfnPackageGroup.RestrictionTypeProperty(*, restriction_mode, repositories=None)

Bases: object

The RestrictionType property type specifies the package group origin configuration restriction mode, and the repositories when the RestrictionMode is set to ALLOW_SPECIFIC_REPOSITORIES .

Parameters:

  • restriction_mode (str) – The package group origin restriction setting. When the value is INHERIT , the value is set to the value of the first parent package group which does not have a value of INHERIT .

  • repositories (Optional[Sequence[str]]) – The repositories to add to the allowed repositories list. The allowed repositories list is used when the RestrictionMode is set to ALLOW_SPECIFIC_REPOSITORIES .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictiontype.html

ExampleMetadata:

fixture=_generated

Example:

# 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

restriction_type_property = codeartifact.CfnPackageGroup.RestrictionTypeProperty(
    restriction_mode="restrictionMode",

    # the properties below are optional
    repositories=["repositories"]
)

Attributes

repositories

The repositories to add to the allowed repositories list.

The allowed repositories list is used when the RestrictionMode is set to ALLOW_SPECIFIC_REPOSITORIES .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictiontype.html#cfn-codeartifact-packagegroup-restrictiontype-repositories

restriction_mode

The package group origin restriction setting.

When the value is INHERIT , the value is set to the value of the first parent package group which does not have a value of INHERIT .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictiontype.html#cfn-codeartifact-packagegroup-restrictiontype-restrictionmode

RestrictionsProperty

class CfnPackageGroup.RestrictionsProperty(*, external_upstream=None, internal_upstream=None, publish=None)

Bases: object

Contains information about the configured restrictions of the origin controls of a package group.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictions.html

ExampleMetadata:

fixture=_generated

Example:

# 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

restrictions_property = 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"]
    )
)

Attributes

external_upstream

The package group origin restriction setting for external, upstream repositories.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictions.html#cfn-codeartifact-packagegroup-restrictions-externalupstream

internal_upstream

The package group origin restriction setting for internal, upstream repositories.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictions.html#cfn-codeartifact-packagegroup-restrictions-internalupstream

publish

The package group origin restriction setting for publishing packages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codeartifact-packagegroup-restrictions.html#cfn-codeartifact-packagegroup-restrictions-publish