Package software.amazon.awscdk.services.sso

Class CfnApplication

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sso.CfnApplication
All Implemented Interfaces:
IInspectable, ITaggableV2, IApplicationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:47.727Z") @Stability(Stable) public class CfnApplication extends CfnResource implements IInspectable, IApplicationRef, ITaggableV2
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.

This API does not support creating SAML 2.0 customer managed applications or AWS managed applications. To learn how to create an AWS managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the AWS Management Console only. See Setting up customer managed SAML 2.0 applications . For more information on these application types, see AWS managed applications .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sso.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .applicationProviderArn("applicationProviderArn")
         .instanceArn("instanceArn")
         .name("name")
         // the properties below are optional
         .description("description")
         .portalOptions(PortalOptionsConfigurationProperty.builder()
                 .signInOptions(SignInOptionsProperty.builder()
                         .origin("origin")
                         // the properties below are optional
                         .applicationUrl("applicationUrl")
                         .build())
                 .visibility("visibility")
                 .build())
         .status("status")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApplication

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

    • CfnApplication

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

    • CfnApplication

      @Stability(Stable) public CfnApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getApplicationRef

      @Stability(Stable) @NotNull public ApplicationReference getApplicationRef()
      A reference to a Application resource.
      Specified by:
      getApplicationRef in interface IApplicationRef

    • getAttrApplicationArn

      @Stability(Stable) @NotNull public String getAttrApplicationArn()
      The ARN of the application.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationProviderArn

      @Stability(Stable) @NotNull public String getApplicationProviderArn()
      The ARN of the application provider for this application.

    • setApplicationProviderArn

      @Stability(Stable) public void setApplicationProviderArn(@NotNull String value)
      The ARN of the application provider for this application.

    • getInstanceArn

      @Stability(Stable) @NotNull public String getInstanceArn()
      The ARN of the instance of IAM Identity Center that is configured with this application.

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@NotNull String value)
      The ARN of the instance of IAM Identity Center that is configured with this application.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the application.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the application.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the application.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the application.

    • getPortalOptions

      @Stability(Stable) @Nullable public Object getPortalOptions()
      A structure that describes the options for the access portal associated with this application.

      Returns union: either IResolvable or CfnApplication.PortalOptionsConfigurationProperty

    • setPortalOptions

      @Stability(Stable) public void setPortalOptions(@Nullable IResolvable value)
      A structure that describes the options for the access portal associated with this application.

    • setPortalOptions

      @Stability(Stable) public void setPortalOptions(@Nullable CfnApplication.PortalOptionsConfigurationProperty value)
      A structure that describes the options for the access portal associated with this application.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      The current status of the application in this instance of IAM Identity Center.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      The current status of the application in this instance of IAM Identity Center.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Specifies tags to be attached to the application.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Specifies tags to be attached to the application.