Overview
Resources
Data Types

Credential Object

Description

Specification for a registered credential.

Properties

amazonIamAccessKey

Parameters for the IAM access key credential. Present when credentialType is amazon-access-key.

Type: AmazonIamAccessKeyParameters object.

amazonIamRole

Parameters for the IAM role credential. Present when credentialType is amazon-iam-role.

Type: AmazonIamRoleParameters object.

actionIds

IDs of the actions using the credential.

Type: array of string

cloudProviderSubTypeId

Cloud-provider sub-type ID.

Type: string

Valid Values:

  • amazon-standard

  • amazon-govcloud-us

  • amazon-china

createdDate

Date, in ISO 8601 format, when the credential was registered.

Type: string

credentialId

ID of the credential.

Type: string

credentialType

Type of credential.

Type: string

Valid Values:

  • amazon-iam-role

  • amazon-access-key

isUsedForSnsNotifications

True if the credential is configured to send SNS notifications. False otherwise.

Type: boolean

lastModifiedDate

Date, in ISO 8601 format, when the credential was last modified.

Type: string

lastModifiedBy

ID of the user whom last modified the credential.

Type: string

managedInstanceIds

IDs of the Managed Instances using the credential.

Type: array of string

name

Friendly name for the credential.

Type: string

status

Status of the credential.

Type: string

Valid Values:

  • active

  • deleted

Sample JSON for an IAM role

{
"actionIds": [
"a-00000001"
],
"amazonIamRole": {
"roleArn": "arn:aws:iam::123456789012:role/Skeddly",
"externalId": "skeddly-12345678"
},
"cloudProviderSubTypeId": "amazon-standard",
"createdDate": "2016-06-08T14:42:00Z",
"credentialId": "cred-00000001",
"credentialType": "amazon-iam-role",
‚Äč
"isUsedForSnsNotifications": false,
"lastModifiedDate": "2016-06-08T14:42:00Z",
"lastModifiedBy": "u-00000001",
"managedInstanceIds": [
"mi-00000001"
],
"name": "My Credential",
"status": "active"
}

Sample JSON for an IAM access key

{
"actionIds": [
"a-00000001"
],
"amazonIamAccessKey": {
"accessKeyId": "AK123456789012345678",
},
"cloudProviderSubTypeId": "amazon-standard",
"createdDate": "2016-06-08T14:42:00Z",
"credentialId": "cred-00000001",
"credentialType": "amazon-access-key",
"isUsedForSnsNotifications": false,
"lastModifiedDate": "2016-06-08T14:42:00Z",
"lastModifiedBy": "u-00000001",
"managedInstanceIds": [
"mi-00000001"
],
"name": "My Credential",
"status": "active"
}