Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. workspacesweb
  5. IdentityProvider

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.workspacesweb.IdentityProvider

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::WorkSpacesWeb::IdentityProvider Resource Type

    Create IdentityProvider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IdentityProvider(name: string, args: IdentityProviderArgs, opts?: CustomResourceOptions);
    @overload
def IdentityProvider(resource_name: str,
                     args: IdentityProviderArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def IdentityProvider(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     identity_provider_details: Optional[Mapping[str, str]] = None,
                     identity_provider_type: Optional[IdentityProviderType] = None,
                     identity_provider_name: Optional[str] = None,
                     portal_arn: Optional[str] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewIdentityProvider(ctx *Context, name string, args IdentityProviderArgs, opts ...ResourceOption) (*IdentityProvider, error)
    public IdentityProvider(string name, IdentityProviderArgs args, CustomResourceOptions? opts = null)
    public IdentityProvider(String name, IdentityProviderArgs args)
public IdentityProvider(String name, IdentityProviderArgs args, CustomResourceOptions options)

    type: aws-native:workspacesweb:IdentityProvider
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IdentityProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IdentityProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IdentityProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    IdentityProvider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IdentityProvider resource accepts the following input properties:

    IdentityProviderDetails Dictionary<string, string>

    The identity provider details. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

    • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

    • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

    • authorize_scopes

    • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • authorize_url if not available from discovery URL specified by oidc_issuer key

    • token_url if not available from discovery URL specified by oidc_issuer key

    • attributes_url if not available from discovery URL specified by oidc_issuer key

    • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

    • MetadataFile OR MetadataURL

    • IDPSignout (boolean) optional

    • IDPInit (boolean) optional

    • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

    • EncryptedResponses (boolean) optional

    IdentityProviderType Pulumi.AwsNative.WorkSpacesWeb.IdentityProviderType
    The identity provider type.
    IdentityProviderName string
    The identity provider name.
    PortalArn string
    The ARN of the identity provider.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    IdentityProviderDetails map[string]string

    The identity provider details. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

    • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

    • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

    • authorize_scopes

    • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • authorize_url if not available from discovery URL specified by oidc_issuer key

    • token_url if not available from discovery URL specified by oidc_issuer key

    • attributes_url if not available from discovery URL specified by oidc_issuer key

    • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

    • MetadataFile OR MetadataURL

    • IDPSignout (boolean) optional

    • IDPInit (boolean) optional

    • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

    • EncryptedResponses (boolean) optional

    IdentityProviderType IdentityProviderType
    The identity provider type.
    IdentityProviderName string
    The identity provider name.
    PortalArn string
    The ARN of the identity provider.
    Tags TagArgs
    identityProviderDetails Map<String,String>

    The identity provider details. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

    • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

    • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

    • authorize_scopes

    • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • authorize_url if not available from discovery URL specified by oidc_issuer key

    • token_url if not available from discovery URL specified by oidc_issuer key

    • attributes_url if not available from discovery URL specified by oidc_issuer key

    • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

    • MetadataFile OR MetadataURL

    • IDPSignout (boolean) optional

    • IDPInit (boolean) optional

    • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

    • EncryptedResponses (boolean) optional

    identityProviderType IdentityProviderType
    The identity provider type.
    identityProviderName String
    The identity provider name.
    portalArn String
    The ARN of the identity provider.
    tags List<Tag>
    identityProviderDetails {[key: string]: string}

    The identity provider details. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

    • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

    • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

    • authorize_scopes

    • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • authorize_url if not available from discovery URL specified by oidc_issuer key

    • token_url if not available from discovery URL specified by oidc_issuer key

    • attributes_url if not available from discovery URL specified by oidc_issuer key

    • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

    • MetadataFile OR MetadataURL

    • IDPSignout (boolean) optional

    • IDPInit (boolean) optional

    • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

    • EncryptedResponses (boolean) optional

    identityProviderType IdentityProviderType
    The identity provider type.
    identityProviderName string
    The identity provider name.
    portalArn string
    The ARN of the identity provider.
    tags Tag[]
    identity_provider_details Mapping[str, str]

    The identity provider details. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

    • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

    • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

    • authorize_scopes

    • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • authorize_url if not available from discovery URL specified by oidc_issuer key

    • token_url if not available from discovery URL specified by oidc_issuer key

    • attributes_url if not available from discovery URL specified by oidc_issuer key

    • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

    • MetadataFile OR MetadataURL

    • IDPSignout (boolean) optional

    • IDPInit (boolean) optional

    • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

    • EncryptedResponses (boolean) optional

    identity_provider_type IdentityProviderType
    The identity provider type.
    identity_provider_name str
    The identity provider name.
    portal_arn str
    The ARN of the identity provider.
    tags Sequence[TagArgs]
    identityProviderDetails Map<String>

    The identity provider details. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

    • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

    • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

    • authorize_scopes

    • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • authorize_url if not available from discovery URL specified by oidc_issuer key

    • token_url if not available from discovery URL specified by oidc_issuer key

    • attributes_url if not available from discovery URL specified by oidc_issuer key

    • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

    • MetadataFile OR MetadataURL

    • IDPSignout (boolean) optional

    • IDPInit (boolean) optional

    • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

    • EncryptedResponses (boolean) optional

    identityProviderType "SAML" | "Facebook" | "Google" | "LoginWithAmazon" | "SignInWithApple" | "OIDC"
    The identity provider type.
    identityProviderName String
    The identity provider name.
    portalArn String
    The ARN of the identity provider.
    tags List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IdentityProvider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderArn string
    The ARN of the identity provider.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderArn string
    The ARN of the identity provider.
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderArn String
    The ARN of the identity provider.
    id string
    The provider-assigned unique ID for this managed resource.
    identityProviderArn string
    The ARN of the identity provider.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_provider_arn str
    The ARN of the identity provider.
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderArn String
    The ARN of the identity provider.

    Supporting Types

    IdentityProviderType, IdentityProviderTypeArgs

    Saml
    SAML
    Facebook
    Facebook
    Google
    Google
    LoginWithAmazon
    LoginWithAmazon
    SignInWithApple
    SignInWithApple
    Oidc
    OIDC
    IdentityProviderTypeSaml
    SAML
    IdentityProviderTypeFacebook
    Facebook
    IdentityProviderTypeGoogle
    Google
    IdentityProviderTypeLoginWithAmazon
    LoginWithAmazon
    IdentityProviderTypeSignInWithApple
    SignInWithApple
    IdentityProviderTypeOidc
    OIDC
    Saml
    SAML
    Facebook
    Facebook
    Google
    Google
    LoginWithAmazon
    LoginWithAmazon
    SignInWithApple
    SignInWithApple
    Oidc
    OIDC
    Saml
    SAML
    Facebook
    Facebook
    Google
    Google
    LoginWithAmazon
    LoginWithAmazon
    SignInWithApple
    SignInWithApple
    Oidc
    OIDC
    SAML
    SAML
    FACEBOOK
    Facebook
    GOOGLE
    Google
    LOGIN_WITH_AMAZON
    LoginWithAmazon
    SIGN_IN_WITH_APPLE
    SignInWithApple
    OIDC
    OIDC
    "SAML"
    SAML
    "Facebook"
    Facebook
    "Google"
    Google
    "LoginWithAmazon"
    LoginWithAmazon
    "SignInWithApple"
    SignInWithApple
    "OIDC"
    OIDC

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native