Class CfnPackage

Resource Type definition for AWS::CodeArtifact::Package.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnPackage

Implements

IInspectable

IPackageRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.CodeArtifact

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPackage : CfnResource, IInspectable, IPackageRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnPackage Inherits CfnResource Implements IInspectable, IPackageRef, IConstruct, IDependable, IEnvironmentAware

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

Examples

// 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 cfnPackage = new CfnPackage(this, "MyCfnPackage", new CfnPackageProps {
                 DomainName = "domainName",
                 Format = "format",
                 Name = "name",
                 Repository = "repository",

                 // the properties below are optional
                 Namespace = "namespace"
             });

Synopsis

Constructors

CfnPackage(Construct, string, ICfnPackageProps)

Create a new AWS::CodeArtifact::Package.

Properties

AttrArn	The ARN of the package.
AttrOriginConfiguration	The package origin configuration for the package.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Resource Type definition for AWS::CodeArtifact::Package.
CfnPropertyNames	Resource Type definition for AWS::CodeArtifact::Package.
DomainName	The name of the domain that contains the repository that contains the package.
Format	The format of the package.
Name	The name of the package.
Namespace	The namespace of the package.
PackageRef	A reference to a Package resource.
Repository	The name of the repository that contains the package.

Methods

ArnForPackage(IPackageRef)	Resource Type definition for AWS::CodeArtifact::Package.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnPackage(object)	Checks whether the given object is a CfnPackage.
RenderProperties(IDictionary<string, object>)	Resource Type definition for AWS::CodeArtifact::Package.

Constructors

CfnPackage(Construct, string, ICfnPackageProps)

Create a new AWS::CodeArtifact::Package.

public CfnPackage(Construct scope, string id, ICfnPackageProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnPackageProps

Resource properties.

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the package.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrOriginConfiguration

The package origin configuration for the package.

public virtual IResolvable AttrOriginConfiguration { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: OriginConfiguration

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

CfnProperties

Resource Type definition for AWS::CodeArtifact::Package.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

CfnPropertyNames

Resource Type definition for AWS::CodeArtifact::Package.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

DomainName

The name of the domain that contains the repository that contains the package.

public virtual string DomainName { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

Format

The format of the package.

public virtual string Format { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

Name

The name of the package.

public virtual string Name { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

Namespace

The namespace of the package.

public virtual string? Namespace { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

PackageRef

A reference to a Package resource.

public virtual IPackageReference PackageRef { get; }

Property Value

IPackageReference

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

Repository

The name of the repository that contains the package.

public virtual string Repository { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

Methods

ArnForPackage(IPackageRef)

Resource Type definition for AWS::CodeArtifact::Package.

public static string ArnForPackage(IPackageRef resource)

Parameters

resource IPackageRef

Returns

string

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

Examples

// 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 cfnPackage = new CfnPackage(this, "MyCfnPackage", new CfnPackageProps {
                 DomainName = "domainName",
                 Format = "format",
                 Name = "name",
                 Repository = "repository",

                 // the properties below are optional
                 Namespace = "namespace"
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

IsCfnPackage(object)

Checks whether the given object is a CfnPackage.

public static bool IsCfnPackage(object x)

Parameters

x object

Returns

bool

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Resource Type definition for AWS::CodeArtifact::Package.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::CodeArtifact::Package

ExampleMetadata: fixture=_generated

Implements

IInspectable

IPackageRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware