in addons/addon-base-raas/packages/base-raas-services/lib/environment/service-catalog/environment-config-vars-service.js [67:164]
async list(requestContext) {
return [
{
name: 'envId',
desc: 'A unique identifier for the environment assigned at the time of launching the environment',
},
{
name: 'envTypeId',
desc: 'Id of this environment type',
},
{
name: 'envTypeConfigId',
desc: 'Id of this configuration',
},
{ name: 'name', desc: 'Name of the environment specified at the time of launching the environment' },
{
name: 'description',
desc: 'Description of the environment specified at the time of launching the environment',
},
{
name: 'adminKeyPairName',
desc:
'AWS EC2 Key Pair Name for environment administration (useful for Windows based environments).' +
' If you use this variable, a new EC2 key pair will be created at the time of launching the environment and' +
" the key pair's name will be passed via this variable. Use this variable ONLY IF you want to " +
'specify a static key pair. This may be required for ' +
"Windows based instances to retrieve default Administrator user's password. You do not need to use any key " +
'pair for SSH if you are launching instances that have EC2 ' +
'Instance Connect Agent (Amazon Linux 2 2.0.20190618 or later and Ubuntu 20.04 or later comes preconfigured ' +
'with EC2 Instance Connect). Users will be able to SSH to the linux based instances using the key pairs ' +
'they create on this platform. They will be able to SSH using EC2 Instance Connect without requiring any ' +
'static key pairs. ',
},
{ name: 'accountId', desc: 'AWS Account ID of the target account where the environment is launched' },
{ name: 'projectId', desc: 'Project Id associated with the environment' },
{ name: 'indexId', desc: 'Index Id (Cost Center Id) associated with the environment' },
{ name: 'cidr', desc: 'The IP CIDR range specified at the time launching the environment' },
{
name: 'vpcId',
desc: 'Vpc Id in the target account to launch environments into',
},
{
name: 'subnetId',
desc: 'Subnet Id in the target account to launch environments into',
},
{
name: 'encryptionKeyArn',
desc: 'ARN of the KMS key used for encrypting data',
},
{
name: 'xAccEnvMgmtRoleArn',
desc: 'Arn of the role used for managing environments in the target account using AWS Service Catalog',
},
{
name: 'externalId',
desc: 'External Id required to assumed the WS Service Catalog Admin role in the target account',
},
{ name: 'studyIds', desc: 'Comma separated list of study ids associated with the environment (if any)' },
{
name: 's3Mounts',
desc:
'A JSON array of objects with name, bucket and prefix properties used to mount data from S3 based on the associated studies',
},
// { name: 's3Prefixes', desc: 'A JSON array of S3 prefixes based on the associated studies' },
{ name: 'iamPolicyDocument', desc: 'The IAM policy to be associated with the launched environment workstation' },
{
name: 'egressStoreIamPolicyDocument',
desc: 'The IAM policy for launched workstation to access egress store',
},
{
name: 'environmentInstanceFiles',
desc:
'An S3 URI (starting with "s3://") that specifies the location of files to be copied to the environment ' +
'instance, including any bootstrap scripts',
},
{
name: 'uid',
desc: 'A unique identifier for the user launching the environment',
},
{
name: 'username',
desc: 'Username of the user launching the environment',
},
{
name: 'userNamespace',
desc:
'Namespace of the username launching the environment. The userNamespace is derived based on the identity provider which authenticated the user',
},
{
name: 'isAppStreamEnabled',
desc: 'Is AppStream enabled for this workspace',
},
{
name: 'solutionNamespace',
desc: 'The namespace value provided when onboarding the Member account',
},
];
}