create_stack ¶

def create_stack(
    self,
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    name: Optional["capo_appstream.types.name.Name"] = None,
    description: Optional["capo_appstream.types.description.Description"] = None,
    display_name: Optional["capo_appstream.types.display_name.DisplayName"] = None,
    storage_connectors: Optional[
        "capo_appstream.types.storage_connector_list.StorageConnectorList"
    ] = None,
    redirect_url: Optional["capo_appstream.types.redirect_url.RedirectURL"] = None,
    feedback_url: Optional["capo_appstream.types.feedback_url.FeedbackURL"] = None,
    user_settings: Optional[
        "capo_appstream.types.user_setting_list.UserSettingList"
    ] = None,
    application_settings: Optional[
        "capo_appstream.types.application_settings.ApplicationSettings"
    ] = None,
    tags: Optional["capo_appstream.types.tags.Tags"] = None,
    access_endpoints: Optional[
        "capo_appstream.types.access_endpoint_list.AccessEndpointList"
    ] = None,
    embed_host_domains: Optional[
        "capo_appstream.types.embed_host_domains.EmbedHostDomains"
    ] = None,
    streaming_experience_settings: Optional[
        "capo_appstream.types.streaming_experience_settings.StreamingExperienceSettings"
    ] = None,
    content_redirection: Optional[
        "capo_appstream.types.content_redirection.ContentRedirection"
    ] = None,
    agent_access_config: Optional[
        "capo_appstream.types.agent_access_config.AgentAccessConfig"
    ] = None,
    storage_connector_authentication: Optional[
        "capo_appstream.types.storage_connector_authentication.StorageConnectorAuthentication"
    ] = None,
) -> "capo_appstream.types.create_stack_result.CreateStackResult":
    r"""<p>Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. </p>

    Args:
        name: <p>The name of the stack.</p>
        description: <p>The description to display.</p>
        display_name: <p>The stack name to display.</p>
        storage_connectors: <p>The storage connectors to enable.</p>
        redirect_url: <p>The URL that users are redirected to after their streaming session ends.</p>
        feedback_url: <p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>
        user_settings: <p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. </p>
        application_settings: <p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>
        tags: <p>The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \ - @</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html">Tagging Your Resources</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
        access_endpoints: <p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.</p>
        embed_host_domains: <p>The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions. </p>
        streaming_experience_settings: <p>The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.</p>
        agent_access_config: <p>The configuration for agent access on the stack. If specified, agent access is enabled for the stack.</p>
        storage_connector_authentication: <p>Specifies whether users' cloud storage authentication persists across streaming sessions. When you specify FORCE_REAUTHENTICATION, WorkSpaces Applications removes the stored authentication for the stack's OneDrive and Google Drive connectors when a user's session ends. The user links their cloud storage again on their next session. The default is REUSE_CREDENTIALS.</p>

    Raises:
        capo_appstream.errors.concurrent_modification_exception.ConcurrentModificationException: <p>An API error occurred. Wait a few minutes and try again.</p>
        capo_appstream.errors.invalid_account_status_exception.InvalidAccountStatusException: <p>The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support. </p>
        capo_appstream.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Indicates an incorrect combination of parameters, or a missing parameter.</p>
        capo_appstream.errors.invalid_role_exception.InvalidRoleException: <p>The specified role is invalid.</p>
        capo_appstream.errors.limit_exceeded_exception.LimitExceededException: <p>The requested limit exceeds the permitted limit for an account.</p>
        capo_appstream.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>The attempted operation is not permitted.</p>
        capo_appstream.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The specified resource already exists.</p>
        capo_appstream.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_appstream.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appstream.types.create_stack_request.CreateStackRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.create_stack_result.CreateStackResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.create_stack

        output, http_response = (
            capo_appstream._operations.photon_admin_proxy_service.create_stack.create_stack(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateStack")
    )
    input_: capo_appstream.types.create_stack_request.CreateStackRequest = {}
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if display_name is not None:
        input_["display_name"] = display_name
    if storage_connectors is not None:
        input_["storage_connectors"] = storage_connectors
    if redirect_url is not None:
        input_["redirect_url"] = redirect_url
    if feedback_url is not None:
        input_["feedback_url"] = feedback_url
    if user_settings is not None:
        input_["user_settings"] = user_settings
    if application_settings is not None:
        input_["application_settings"] = application_settings
    if tags is not None:
        input_["tags"] = tags
    if access_endpoints is not None:
        input_["access_endpoints"] = access_endpoints
    if embed_host_domains is not None:
        input_["embed_host_domains"] = embed_host_domains
    if streaming_experience_settings is not None:
        input_["streaming_experience_settings"] = streaming_experience_settings
    if content_redirection is not None:
        input_["content_redirection"] = content_redirection
    if agent_access_config is not None:
        input_["agent_access_config"] = agent_access_config
    if storage_connector_authentication is not None:
        input_["storage_connector_authentication"] = (
            storage_connector_authentication
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output