CfnApplicationPropsMixin

class aws_cdk.mixins_preview.aws_sso.mixins.CfnApplicationPropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-application.html
CloudformationResource:: AWS::SSO::Application
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_sso import mixins as sso_mixins

cfn_application_props_mixin = sso_mixins.CfnApplicationPropsMixin(sso_mixins.CfnApplicationMixinProps(
    application_provider_arn="applicationProviderArn",
    description="description",
    instance_arn="instanceArn",
    name="name",
    portal_options=sso_mixins.CfnApplicationPropsMixin.PortalOptionsConfigurationProperty(
        sign_in_options=sso_mixins.CfnApplicationPropsMixin.SignInOptionsProperty(
            application_url="applicationUrl",
            origin="origin"
        ),
        visibility="visibility"
    ),
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SSO::Application.

Parameters:

props (Union[CfnApplicationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationProviderArn', 'description', 'instanceArn', 'name', 'portalOptions', 'status', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

PortalOptionsConfigurationProperty

class CfnApplicationPropsMixin.PortalOptionsConfigurationProperty(*, sign_in_options=None, visibility=None)

Bases: object

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

Parameters:

sign_in_options (Union[IResolvable, SignInOptionsProperty, Dict[str, Any], None]) – A structure that describes the sign-in options for the access portal.
visibility (Optional[str]) – Indicates whether this application is visible in the access portal.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-portaloptionsconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_sso import mixins as sso_mixins

portal_options_configuration_property = sso_mixins.CfnApplicationPropsMixin.PortalOptionsConfigurationProperty(
    sign_in_options=sso_mixins.CfnApplicationPropsMixin.SignInOptionsProperty(
        application_url="applicationUrl",
        origin="origin"
    ),
    visibility="visibility"
)

Attributes

sign_in_options

A structure that describes the sign-in options for the access portal.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-portaloptionsconfiguration.html#cfn-sso-application-portaloptionsconfiguration-signinoptions

visibility

Indicates whether this application is visible in the access portal.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-portaloptionsconfiguration.html#cfn-sso-application-portaloptionsconfiguration-visibility

SignInOptionsProperty

class CfnApplicationPropsMixin.SignInOptionsProperty(*, application_url=None, origin=None)

Bases: object

A structure that describes the sign-in options for an application portal.

Parameters:

application_url (Optional[str]) – The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION .
origin (Optional[str]) – This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values: - APPLICATION : IAM Identity Center redirects the customer to the configured ApplicationUrl . - IDENTITY_CENTER : IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-signinoptions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_sso import mixins as sso_mixins

sign_in_options_property = sso_mixins.CfnApplicationPropsMixin.SignInOptionsProperty(
    application_url="applicationUrl",
    origin="origin"
)

Attributes

application_url

The URL that accepts authentication requests for an application.

This is a required parameter if the Origin parameter is APPLICATION .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-signinoptions.html#cfn-sso-application-signinoptions-applicationurl

origin

This determines how IAM Identity Center navigates the user to the target application.

It can be one of the following values:

APPLICATION : IAM Identity Center redirects the customer to the configured ApplicationUrl .
IDENTITY_CENTER : IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sso-application-signinoptions.html#cfn-sso-application-signinoptions-origin