create_app_block_builder ¶

def create_app_block_builder(
    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,
    tags: Optional["capo_appstream.types.tags.Tags"] = None,
    platform: Optional[
        "capo_appstream.types.app_block_builder_platform_type.AppBlockBuilderPlatformType"
    ] = None,
    instance_type: Optional["capo_appstream.types.string.String"] = None,
    vpc_config: Optional["capo_appstream.types.vpc_config.VpcConfig"] = None,
    enable_default_internet_access: Optional[
        "capo_appstream.types.boolean_object.BooleanObject"
    ] = None,
    iam_role_arn: Optional["capo_appstream.types.arn.Arn"] = None,
    access_endpoints: Optional[
        "capo_appstream.types.access_endpoint_list.AccessEndpointList"
    ] = None,
    disable_imdsv1: Optional[
        "capo_appstream.types.boolean_object.BooleanObject"
    ] = None,
) -> "capo_appstream.types.create_app_block_builder_result.CreateAppBlockBuilderResult":
    r"""<p>Creates an app block builder.</p>

    Args:
        name: <p>The unique name for the app block builder.</p>
        description: <p>The description of the app block builder.</p>
        display_name: <p>The display name of the app block builder.</p>
        tags: <p>The tags to associate with the app block builder. 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, 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>
        platform: <p>The platform of the app block builder.</p> <p> <code>WINDOWS_SERVER_2019</code> is the only valid value.</p>
        instance_type: <p>The instance type to use when launching the app block builder. The following instance types are available:</p> <ul> <li> <p>stream.standard.small</p> </li> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.standard.xlarge</p> </li> <li> <p>stream.standard.2xlarge</p> </li> </ul>
        vpc_config: <p>The VPC configuration for the app block builder.</p> <p>App block builders require that you specify at least two subnets in different availability zones.</p>
        enable_default_internet_access: <p>Enables or disables default internet access for the app block builder.</p>
        iam_role_arn: <p>The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the <b>appstream_machine_role</b> credential profile on the instance.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html">Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances</a> in the <i>Amazon WorkSpaces Applications Administration Guide</i>.</p>
        access_endpoints: <p>The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.</p>
        disable_imdsv1: <p>Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.</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.request_limit_exceeded_exception.RequestLimitExceededException: <p>WorkSpaces Applications can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.</p>
        capo_appstream.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The specified resource already exists.</p>
        capo_appstream.errors.resource_not_available_exception.ResourceNotAvailableException: <p>The specified resource exists and is not in use, but isn't available.</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_app_block_builder_request.CreateAppBlockBuilderRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.create_app_block_builder_result.CreateAppBlockBuilderResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.create_app_block_builder

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateAppBlockBuilder")
    )
    input_: capo_appstream.types.create_app_block_builder_request.CreateAppBlockBuilderRequest = {}
    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 tags is not None:
        input_["tags"] = tags
    if platform is not None:
        input_["platform"] = platform
    if instance_type is not None:
        input_["instance_type"] = instance_type
    if vpc_config is not None:
        input_["vpc_config"] = vpc_config
    if enable_default_internet_access is not None:
        input_["enable_default_internet_access"] = enable_default_internet_access
    if iam_role_arn is not None:
        input_["iam_role_arn"] = iam_role_arn
    if access_endpoints is not None:
        input_["access_endpoints"] = access_endpoints
    if disable_imdsv1 is not None:
        input_["disable_imdsv1"] = disable_imdsv1

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