Class Application

(experimental) A Service Catalog AppRegistry Application.

Inheritance

object

Resource

Application

Implements

IApplication

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Servicecatalogappregistry.Alpha

Assembly: Amazon.CDK.AWS.ServiceCatalogAppRegistry.Alpha.dll

Syntax (csharp)

public class Application : Resource, IApplication, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class Application Inherits Resource Implements IApplication, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

var application = new Application(this, "MyFirstApplication", new ApplicationProps {
                 ApplicationName = "MyFirstApplicationName",
                 Description = "description for my application"
             });

Synopsis

Constructors

Application(Construct, string, IApplicationProps)

(experimental) A Service Catalog AppRegistry Application.

Properties

ApplicationArn	(experimental) The ARN of the application.
ApplicationId	(experimental) The ID of the application.
ApplicationManagerUrl	(experimental) Application manager URL for the Application.
ApplicationName	(experimental) The name of the application.
PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Methods

AddAttributeGroup(string, IAttributeGroupAssociationProps)	(experimental) Create an attribute group and associate this application with the created attribute group.
AssociateAllStacksInScope(Construct)	(experimental) Associate all stacks present in construct's aspect with application, including cross-account stacks.
AssociateApplicationWithStack(Stack)	(experimental) Associate stack with the application in the stack passed as parameter.
AssociateAttributeGroup(IAttributeGroup)	(deprecated) Associate an attribute group with application If the attribute group is already associated, it will ignore duplicate request.
AssociateStack(Stack)	(deprecated) Associate a stack with the application If the resource is already associated, it will ignore duplicate request.
FromApplicationArn(Construct, string, string)	(experimental) Imports an Application construct that represents an external application.
GenerateUniqueHash(string)	(experimental) Create a unique id.
ShareApplication(string, IShareOptions)	(experimental) Share an application with accounts, organizations and OUs, and IAM roles and users.

Constructors

Application(Construct, string, IApplicationProps)

(experimental) A Service Catalog AppRegistry Application.

public Application(Construct scope, string id, IApplicationProps props)

Parameters

scope Construct
id string
props IApplicationProps

Remarks

Stability: Experimental

Properties

ApplicationArn

(experimental) The ARN of the application.

public virtual string ApplicationArn { get; }

Property Value

string

Remarks

Stability: Experimental

ApplicationId

(experimental) The ID of the application.

public virtual string ApplicationId { get; }

Property Value

string

Remarks

Stability: Experimental

ApplicationManagerUrl

(experimental) Application manager URL for the Application.

public virtual string? ApplicationManagerUrl { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

ApplicationName

(experimental) The name of the application.

public virtual string? ApplicationName { get; }

Property Value

string

Remarks

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

Methods

AddAttributeGroup(string, IAttributeGroupAssociationProps)

(experimental) Create an attribute group and associate this application with the created attribute group.

public virtual IAttributeGroup AddAttributeGroup(string id, IAttributeGroupAssociationProps props)

Parameters

id string
props IAttributeGroupAssociationProps

Returns

IAttributeGroup

Remarks

Stability: Experimental

AssociateAllStacksInScope(Construct)

(experimental) Associate all stacks present in construct's aspect with application, including cross-account stacks.

public virtual void AssociateAllStacksInScope(Construct scope)

Parameters

scope Construct

Remarks

NOTE: This method won't automatically register stacks under pipeline stages, and requires association of each pipeline stage by calling this method with stage Construct.

Stability: Experimental

AssociateApplicationWithStack(Stack)

(experimental) Associate stack with the application in the stack passed as parameter.

public virtual void AssociateApplicationWithStack(Stack stack)

Parameters

stack Stack

Remarks

A stack can only be associated with one application.

Stability: Experimental

AssociateAttributeGroup(IAttributeGroup)

(deprecated) Associate an attribute group with application If the attribute group is already associated, it will ignore duplicate request.

[Obsolete("Use `AttributeGroup.associateWith` instead.")]
public virtual void AssociateAttributeGroup(IAttributeGroup attributeGroup)

Parameters

attributeGroup IAttributeGroup

Remarks

Stability: Deprecated

AssociateStack(Stack)

(deprecated) Associate a stack with the application If the resource is already associated, it will ignore duplicate request.

[Obsolete("Use `associateApplicationWithStack` instead.")]
public virtual void AssociateStack(Stack stack)

Parameters

stack Stack

Remarks

A stack can only be associated with one application.

Stability: Deprecated

FromApplicationArn(Construct, string, string)

(experimental) Imports an Application construct that represents an external application.

public static IApplication FromApplicationArn(Construct scope, string id, string applicationArn)

Parameters

scope Construct: The parent creating construct (usually this).
id string: The construct's name.
applicationArn string: the Amazon Resource Name of the existing AppRegistry Application.

Returns

IApplication

Remarks

Stability: Experimental

GenerateUniqueHash(string)

(experimental) Create a unique id.

protected virtual string GenerateUniqueHash(string resourceAddress)

Parameters

resourceAddress string

Returns

string

Remarks

Stability: Experimental

ShareApplication(string, IShareOptions)

(experimental) Share an application with accounts, organizations and OUs, and IAM roles and users.

public virtual void ShareApplication(string id, IShareOptions shareOptions)

Parameters

id string: The construct name for the share.
shareOptions IShareOptions: The options for the share.

Remarks

The application will become available to end users within those principals.

Stability: Experimental

Implements

IApplication

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware