CreateEnvironmentRequest ¶

class CreateEnvironmentRequest(TypedDict, closed=True):
    name: "capo_finspace.types.environment_name.EnvironmentName"
    """<p>The name of the FinSpace environment to be created.</p>"""
    description: NotRequired["capo_finspace.types.description.Description"]
    """<p>The description of the FinSpace environment to be created.</p>"""
    kms_key_id: NotRequired["capo_finspace.types.kms_key_id.KmsKeyId"]
    """<p>The KMS key id to encrypt your data in the FinSpace environment.</p>"""
    tags: NotRequired["capo_finspace.types.tag_map.TagMap"]
    """<p>Add tags to your FinSpace environment.</p>"""
    federation_mode: NotRequired["capo_finspace.types.federation_mode.FederationMode"]
    """<p>Authentication mode for the environment.</p> <ul> <li> <p> <code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider.</p> </li> <li> <p> <code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment.</p> </li> </ul>"""
    federation_parameters: NotRequired[
        "capo_finspace.types.federation_parameters.FederationParameters"
    ]
    """<p>Configuration information when authentication mode is FEDERATED.</p>"""
    superuser_parameters: NotRequired[
        "capo_finspace.types.superuser_parameters.SuperuserParameters"
    ]
    """<p>Configuration information for the superuser.</p>"""
    data_bundles: NotRequired["capo_finspace.types.data_bundle_arns.DataBundleArns"]
    """<p>The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:</p> <ul> <li> <p> <code>arn:aws:finspace:${Region}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies.</p> </li> <li> <p> <code>arn:aws:finspace:${Region}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data.</p> </li> </ul>"""