create-studio¶
Description¶
Create a new studio.
When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.
The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
You may optionally specify a KMS key in the StudioEncryptionConfiguration .
In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage.
When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
If you delete this grant, the studio will no longer be accessible to your portal users.
If you delete the studio KMS key, your studio will no longer be accessible.
See also: AWS API Documentation
Synopsis¶
create-studio
--admin-role-arn <value>
[--client-token <value>]
--display-name <value>
[--studio-encryption-configuration <value>]
--studio-name <value>
[--tags <value>]
--user-role-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--admin-role-arn (string)
The IAM role that studio admins will assume when logging in to the Nimble Studio portal.
--client-token (string)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
--display-name (string)
A friendly name for the studio.
--studio-encryption-configuration (structure)
The studio encryption configuration.
keyArn -> (string)
The ARN for a KMS key that is used to encrypt studio data.keyType -> (string)
The type of KMS key that is used to encrypt studio data.
Shorthand Syntax:
keyArn=string,keyType=string
JSON Syntax:
{
"keyArn": "string",
"keyType": "AWS_OWNED_KEY"|"CUSTOMER_MANAGED_KEY"
}
--studio-name (string)
The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.
--tags (map)
A collection of labels, in the form of key-value pairs, that apply to this resource.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--user-role-arn (string)
The IAM role that studio users will assume when logging in to the Nimble Studio portal.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
studio -> (structure)
Information about a studio.
adminRoleArn -> (string)
The IAM role that studio admins assume when logging in to the Nimble Studio portal.arn -> (string)
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.createdAt -> (timestamp)
The ISO timestamp in seconds for when the resource was created.displayName -> (string)
A friendly name for the studio.homeRegion -> (string)
The Amazon Web Services Region where the studio resource is located.ssoClientId -> (string)
The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.state -> (string)
The current state of the studio resource.statusCode -> (string)
Status codes that provide additional detail on the studio state.statusMessage -> (string)
Additional detail on the studio state.studioEncryptionConfiguration -> (structure)
Configuration of the encryption method that is used for the studio.
keyArn -> (string)
The ARN for a KMS key that is used to encrypt studio data.keyType -> (string)
The type of KMS key that is used to encrypt studio data.studioId -> (string)
The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.studioName -> (string)
The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.studioUrl -> (string)
The address of the web page for the studio.tags -> (map)
A collection of labels, in the form of key-value pairs, that apply to this resource.
key -> (string)
value -> (string)
updatedAt -> (timestamp)
The ISO timestamp in seconds for when the resource was updated.userRoleArn -> (string)
The IAM role that studio users assume when logging in to the Nimble Studio portal.