Document
ssm.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | ssm-controller/apis/v1alpha1#Document |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Document |
| ListKind | DocumentList |
| Plural | documents |
| Singular | document |
Spec
attachments:
- key: string
name: string
values:
- string
content: string
displayName: string
documentFormat: string
documentType: string
name: string
requires:
- name: string
requireType: string
version: string
versionName: string
tags:
- key: string
value: string
targetType: string
versionName: string
| Field | Description |
|---|---|
| attachments Optional | array A list of key-value pairs that describe attachments to a version of a document. |
| attachments.[] Required | object Identifying information about a document attachment, including the file name |
| and a key-value pair that identifies the location of an attachment to a document. | |
| attachments.[].name Optional | string |
| attachments.[].values Optional | array |
| attachments.[].values.[] Required | string |
| displayName Optional | string An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation. |
| documentFormat Optional | string Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format. |
| documentType Optional | string The type of document to create. The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig. |
| name Required | string A name for the SSM document. You can’t use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes: * aws * amazon * amzn |
| requires Optional | array A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AppConfig? (https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the AppConfig User Guide. |
| requires.[] Required | object An SSM document required by the current document. |
| requires.[].requireType Optional | string |
| requires.[].version Optional | string |
| requires.[].versionName Optional | string |
| tags Optional | array Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key-value pairs: * Key=OS,Value=Windows * Key=Environment,Value=Production To add tags to an existing SSM document, use the AddTagsToResource operation. |
| tags.[] Required | object Metadata that you assign to your Amazon Web Services resources. Tags enable |
| you to categorize your resources in different ways, for example, by purpose, | |
| owner, or environment. In Amazon Web Services Systems Manager, you can apply | |
| tags to Systems Manager documents (SSM documents), managed nodes, maintenance | |
| windows, parameters, patch baselines, OpsItems, and OpsMetadata. | |
| tags.[].value Optional | string |
| targetType Optional | string Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of ‘/’ the document can run on all types of resources. If you don’t specify a value, the document can’t run on any resources. For a list of valid resource types, see Amazon Web Services resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the CloudFormation User Guide. |
| versionName Optional | string An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can’t be changed. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
approvedVersion: string
attachmentsInformation:
- name: string
author: string
category:
- string
categoryEnum:
- string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdDate: string
defaultVersion: string
description: string
documentVersion: string
hash: string
hashType: string
latestVersion: string
owner: string
parameters:
- defaultValue: string
description: string
name: string
type_: string
pendingReviewVersion: string
platformTypes:
- string
reviewInformation:
- reviewedTime: string
reviewer: string
status: string
reviewStatus: string
schemaVersion: string
sha1: string
status: string
statusInformation: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| approvedVersion Optional | string The version of the document currently approved for use in the organization. |
| attachmentsInformation Optional | array Details about the document attachments, including names, locations, sizes, and so on. |
| attachmentsInformation.[] Required | object An attribute of an attachment, such as the attachment name. |
| author Optional | string The user in your organization who created the document. |
| category Optional | array The classification of a document to help you identify and categorize its use. |
| category.[] Required | string |
| categoryEnum.[] Required | string |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| createdDate Optional | string The date when the document was created. |
| defaultVersion Optional | string The default version. |
| description Optional | string A description of the document. |
| documentVersion Optional | string The document version. |
| hash Optional | string The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated. |
| hashType Optional | string The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes have been deprecated. |
| latestVersion Optional | string The latest version of the document. |
| owner Optional | string The Amazon Web Services user that created the document. |
| parameters Optional | array A description of the parameters for a document. |
| parameters.[] Required | object Parameters specified in a Systems Manager document that run on the server |
| when the command is run. | |
| parameters.[].description Optional | string |
| parameters.[].name Optional | string |
| **parameters.[].type_** Optional | string |
| pendingReviewVersion Optional | string The version of the document that is currently under review. |
| platformTypes Optional | array The list of operating system (OS) platforms compatible with this SSM document. |
| platformTypes.[] Required | string |
| reviewInformation.[] Required | object Information about the result of a document review request. |
| reviewInformation.[].reviewer Optional | string |
| reviewInformation.[].status Optional | string |
| reviewStatus Optional | string The current status of the review. |
| schemaVersion Optional | string The schema version. |
| sha1 Optional | string The SHA1 hash of the document, which you can use for verification. |
| status Optional | string The status of the SSM document. |
| statusInformation Optional | string A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, “The specified S3 bucket doesn’t exist. Verify that the URL of the S3 bucket is correct.” |