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

Class ApplicationAssociator

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.servicecatalogappregistry.alpha.ApplicationAssociator
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:11.892Z") @Stability(Experimental) public class ApplicationAssociator extends software.constructs.Construct
(experimental) An AppRegistry construct to automatically create an application with the given name and description.

The application name must be unique at the account level per region and it's immutable. This construct will automatically associate all stacks in the given scope, however in case of a Pipeline stack, stage underneath the pipeline will not automatically be associated and needs to be associated separately.

If cross account stack is detected and associateCrossAccountStacks in TargetApplicationOptions is true, then the application will automatically be shared with the consumer accounts to allow associations. Otherwise, the application will not be shared. Cross account feature will only work for non environment agnostic stacks.

Example: 

 import software.amazon.awscdk.*;
 App app = new App();
 ApplicationAssociator associatedApp = ApplicationAssociator.Builder.create(app, "AssociatedApplication")
         .applications(List.of(TargetApplication.createApplicationStack(CreateTargetApplicationOptions.builder()
                 .applicationName("MyAssociatedApplication")
                 // 'Application containing stacks deployed via CDK.' is the default
                 .applicationDescription("Associated Application description")
                 .stackName("MyAssociatedApplicationStack")
                 // AWS Account and Region that are implied by the current CLI configuration is the default
                 .env(Environment.builder().account("123456789012").region("us-east-1").build())
                 .build())))
         .build();
 // Associate application to the attribute group.
 associatedApp.appRegistryApplication.addAttributeGroup("MyAttributeGroup", AttributeGroupAssociationProps.builder()
         .attributeGroupName("MyAttributeGroupName")
         .description("Test attribute group")
         .attributes(Map.of())
         .build());

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ApplicationAssociator.Builder
    (experimental) A fluent builder for ApplicationAssociator.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    ApplicationAssociator(App scope, String id, ApplicationAssociatorProps props)
     
    protected
    ApplicationAssociator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    ApplicationAssociator(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Stage
    associateStage(Stage stage)
    (experimental) Associate this application with the given stage.
    IApplication
    getAppRegistryApplication()
    (experimental) Get the AppRegistry application.
    Boolean
    isStageAssociated(Stage stage)
    (experimental) Validates if a stage is already associated to the application.

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • ApplicationAssociator

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

    • ApplicationAssociator

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

    • ApplicationAssociator

      @Stability(Experimental) public ApplicationAssociator(@NotNull App scope, @NotNull String id, @NotNull ApplicationAssociatorProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • associateStage

      @Stability(Experimental) @NotNull public Stage associateStage(@NotNull Stage stage)
      (experimental) Associate this application with the given stage.

      Parameters:
      stage - This parameter is required.

    • isStageAssociated

      @Stability(Experimental) @NotNull public Boolean isStageAssociated(@NotNull Stage stage)
      (experimental) Validates if a stage is already associated to the application.

      Parameters:
      stage - This parameter is required.

    • getAppRegistryApplication

      @Stability(Experimental) @NotNull public IApplication getAppRegistryApplication()
      (experimental) Get the AppRegistry application.