AwsCloudCredentials object
Polymorphism
AwsCloudCredentials is a type that implements the CloudCredentials type.
When an object of type CloudCredentials is expected, you can use one of type AwsCloudCredentials (or use any other implementation).
Example JSON representation
{
"accessKey": "string",
"accountId": "string",
"accountType": "regular",
"billing": {
"bucket": "string",
"cloudCredentials": {
"id": "string"
},
"cloudLocation": "string",
"enabled": true
},
"cloudCredentialsType": "AwsCloudCredentials",
"description": "string",
"id": "string",
"name": "string",
"provider": "string",
"scope": "scalr",
"secretKey": "string",
"status": "disabled"
}
Properties
property | attributes | valid values | description | filter option |
---|---|---|---|---|
accessKey string |
required |
Access key ID. |
||
accountType string |
required filterable |
"regular" "govcloud" "china" |
AWS Account type. |
?accountType=... |
cloudCredentialsType string |
required create-only filterable |
"AwsCloudCredentials" | The Cloud Platform these credentials allow access to. |
?cloudCredentialsType=... |
name string |
required filterable |
Unique name of these Cloud Credentials. |
?name=... | |
secretKey string |
required |
The secret key. |
||
accountId string |
read-only |
AWS Account ID. |
||
id string |
read-only filterable |
Unique identifier for this Cloud Credentials object. |
?id=... | |
scope string |
read-only filterable |
"scalr" "account" "environment" "farm" "farmrole" "role" "server" |
The scope in which these Cloud Credentials were added. |
?scope=... |
status string |
read-only filterable |
"disabled" "enabled" "suspended" |
The status of these Cloud Credentials. |
?status=... |
billing AwsDetailedBilling object |
optional |
|||
description string |
optional |
|||
provider string |
create-only filterable |
Cloud provider for Openstack or Cloudstack based clouds. |
?provider=... |