Package software.amazon.awscdk.services.sso

Interface CfnApplicationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:46.190Z")
@Stability(Stable)
public interface CfnApplicationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApplication.

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.*;
 CfnApplicationProps cfnApplicationProps = CfnApplicationProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApplicationProps.Builder	A builder for CfnApplicationProps
static final class	CfnApplicationProps.Jsii$Proxy	An implementation for CfnApplicationProps

Method Summary

Modifier and Type	Method	Description
static CfnApplicationProps.Builder	builder()
String	getApplicationProviderArn()	The ARN of the application provider for this application.
default String	getDescription()	The description of the application.
String	getInstanceArn()	The ARN of the instance of IAM Identity Center that is configured with this application.
String	getName()	The name of the application.
default Object	getPortalOptions()	A structure that describes the options for the access portal associated with this application.
default String	getStatus()	The current status of the application in this instance of IAM Identity Center.
default List<CfnTag>	getTags()	Specifies tags to be attached to the application.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationProviderArn

@Stability(Stable)
@NotNull
String getApplicationProviderArn()

The ARN of the application provider for this application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-applicationproviderarn

getInstanceArn

@Stability(Stable)
@NotNull
String getInstanceArn()

The ARN of the instance of IAM Identity Center that is configured with this application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-instancearn

getName

@Stability(Stable)
@NotNull
String getName()

The name of the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-description

getPortalOptions

@Stability(Stable)
@Nullable
default Object getPortalOptions()

A structure that describes the options for the access portal associated with this application.

Returns union: either IResolvable or CfnApplication.PortalOptionsConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-portaloptions

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The current status of the application in this instance of IAM Identity Center.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-status

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Specifies tags to be attached to the application.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html#cfn-sso-application-tags

builder

@Stability(Stable)
static CfnApplicationProps.Builder builder()

Returns:

a CfnApplicationProps.Builder of CfnApplicationProps