Package software.amazon.awscdk.services.servicecatalogappregistry.alpha

Interface IApplication

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IApplication.Jsii$Default

All Known Implementing Classes:

Application, IApplication.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:16.066Z")
@Stability(Experimental)
public interface IApplication
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) A Service Catalog AppRegistry Application.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IApplication.Jsii$Default	Internal default implementation for IApplication.
static final class	IApplication.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
IAttributeGroup	addAttributeGroup(String id, AttributeGroupAssociationProps attributeGroupProps)	(experimental) Create an attribute group and associate this application with the created attribute group.
void	associateAllStacksInScope(software.constructs.Construct construct)	(experimental) Associate this application with all stacks under the construct node.
void	associateApplicationWithStack(Stack stack)	(experimental) Associate a Cloudformation statck with the application in the given stack.
void	associateAttributeGroup(IAttributeGroup attributeGroup)	(experimental) Associate this application with an attribute group.
void	associateStack(Stack stack)	Deprecated. Use associateApplicationWithStack instead.
String	getApplicationArn()	(experimental) The ARN of the application.
String	getApplicationId()	(experimental) The ID of the application.
default String	getApplicationName()	(experimental) The name of the application.
void	shareApplication(String id, ShareOptions shareOptions)	(experimental) Share this application with other IAM entities, accounts, or OUs.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationArn

@Stability(Experimental)
@NotNull
String getApplicationArn()

(experimental) The ARN of the application.

getApplicationId

@Stability(Experimental)
@NotNull
String getApplicationId()

(experimental) The ID of the application.

getApplicationName

@Stability(Experimental)
@Nullable
default String getApplicationName()

(experimental) The name of the application.

addAttributeGroup

@Stability(Experimental)
@NotNull
IAttributeGroup addAttributeGroup(@NotNull
 String id,
 @NotNull
 AttributeGroupAssociationProps attributeGroupProps)

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

Parameters:

id - name of the AttributeGroup construct to be created. This parameter is required.

attributeGroupProps - AppRegistry attribute group props. This parameter is required.

associateAllStacksInScope

@Stability(Experimental)
void associateAllStacksInScope(@NotNull
 software.constructs.Construct construct)

(experimental) Associate this application with all stacks under the construct node.

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.

Parameters:

construct - cdk Construct. This parameter is required.

associateApplicationWithStack

@Stability(Experimental)
void associateApplicationWithStack(@NotNull
 Stack stack)

(experimental) Associate a Cloudformation statck with the application in the given stack.

Parameters:

stack - a CFN stack. This parameter is required.

associateAttributeGroup

@Stability(Experimental)
void associateAttributeGroup(@NotNull
 IAttributeGroup attributeGroup)

(experimental) Associate this application with an attribute group.

Parameters:

attributeGroup - AppRegistry attribute group. This parameter is required.

associateStack

@Stability(Deprecated)
@Deprecated
void associateStack(@NotNull
 Stack stack)

Deprecated.

Use associateApplicationWithStack instead.

(deprecated) Associate this application with a CloudFormation stack.

Parameters:

stack - a CFN stack. This parameter is required.

shareApplication

@Stability(Experimental)
void shareApplication(@NotNull
 String id,
 @NotNull
 ShareOptions shareOptions)

(experimental) Share this application with other IAM entities, accounts, or OUs.

Parameters:

id - The construct name for the share. This parameter is required.

shareOptions - The options for the share. This parameter is required.