configuration_revisions
Creates, updates, deletes, gets or lists a configuration_revisions resource.
Overview
| Name | configuration_revisions |
| Type | Resource |
| Id | aws.kafka.configuration_revisions |
Fields
The following fields are returned by SELECT queries:
- describe_configuration_revision
- list_configuration_revisions
| Name | Datatype | Description |
|---|---|---|
arn | string | The Amazon Resource Name (ARN) of the configuration. |
creation_time | string (date-time) | The time when the configuration was created. |
description | string | The description of the configuration. |
revision | integer (int64) | The revision number. |
server_properties | string (byte) | Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext. |
| Name | Datatype | Description |
|---|---|---|
creation_time | string (date-time) | The time when the configuration revision was created. |
description | string | The description of the configuration revision. |
revision | integer (int64) | The revision number. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_configuration_revision | select | arn, revision, region | Returns a description of this revision of the configuration. | |
list_configuration_revisions | select | arn, region | maxResults, nextToken | Returns a list of all the MSK configurations in this Region. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
arn | string | The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions. |
region | string | AWS region (default: us-east-1) |
revision | integer (int64) | A string that uniquely identifies a revision of an MSK configuration. |
maxResults | integer | The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter. |
nextToken | string | The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request. |
SELECT examples
- describe_configuration_revision
- list_configuration_revisions
Returns a description of this revision of the configuration.
SELECT
arn,
creation_time,
description,
revision,
server_properties
FROM aws.kafka.configuration_revisions
WHERE arn = '{{ arn }}' -- required
AND revision = '{{ revision }}' -- required
AND region = '{{ region }}' -- required
;
Returns a list of all the MSK configurations in this Region.
SELECT
creation_time,
description,
revision
FROM aws.kafka.configuration_revisions
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;