[ aws . pca-connector-ad ]
получить-шаблон
Описание
Получает шаблон сертификата, используемый соединителем для выдачи сертификатов из частного центра сертификации.
См. также: Документацию AWS API
Синтаксис
get-template
--template-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--template-arn (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если не указано значение или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, оно проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включает отладочную запись журнала.
--endpoint-url (строка)
Переопределяет URL по умолчанию команды заданным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.
--no-paginate (логическое значение)
Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определённого профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отображает версию этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- вкл
- выкл
- авто
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с сертификатами CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться без блокировки и таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться без блокировки и таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить пейджер cli для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запросить параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров CLI.
Вывод
Шаблон -> (структура)
Шаблон сертификата, который использует соединитель для выпуска сертификатов из частного центра сертификации.
Arn -> (строка)
ConnectorArn -> (строка)
CreatedAt -> (метка времени)
Definition -> (структура помеченных союзов)
Настройка шаблона для определения информации, включённой в сертификаты. Определите срок действия и периоды продления сертификата, обработку запросов на сертификаты и варианты регистрации, расширения использования ключей, политики приложения и параметры криптографии.
Примечание
Это структура помеченных союзов. Только один из следующих верхнеуровневых ключей может быть установлен:TemplateV2, TemplateV3, TemplateV4.TemplateV2 -> (структура)
Настройка шаблона для определения информации, включённой в сертификаты. Определите срок действия и периоды продления сертификата, обработку запросов на сертификаты и варианты регистрации, расширения использования ключей, политики приложения и параметры криптографии.
CertificateValidity -> (структура)
Срок действия сертификата описывает сроки действия и продления сертификата.
RenewalPeriod -> (структура)
Срок продления — это период времени до истечения срока действия сертификата, когда будет запрошен новый сертификат.
Period -> (длинное целое число)
PeriodType -> (строка)
ValidityPeriod -> (структура)
Информация, описывающая окончание срока действия сертификата. Этот параметр задаёт дату «Не после» для сертификата. Срок действия сертификата — это период времени, в течение которого сертификат действителен. Срок действия может быть выражен как явная дата и время истечения срока действия сертификата, или как интервал времени после выпуска, указанный в днях, месяцах или годах. Дополнительную информацию см. в разделе «Действительность» в RFC 5280. Это значение не изменяется, когда также указан ValidityNotBefore. Например, если Validity задан на 20 дней в будущем, сертификат истечёт через 20 дней от времени выдачи независимо от значения ValidityNotBefore.
Period -> (длинное целое число)
PeriodType -> (строка)
EnrollmentFlags -> (структура)
Флаги регистрации описывают параметры регистрации сертификатов, такие как использование существующего закрытого ключа и удаление истекших или отозванных сертификатов.
EnableKeyReuseOnNtTokenKeysetStorageFull -> (булево)
IncludeSymmetricAlgorithms -> (булево)
NoSecurityExtension -> (булево)
RemoveInvalidCertificateFromPersonalStore -> (булево)
UserInteractionRequired -> (булево)
Extensions -> (структура)
Расширения описывают расширения использования ключей и политики приложения для шаблона.
ApplicationPolicies -> (структура)
Политики приложения указывают, для чего используется сертификат и его назначение.
Critical -> (булево)
Policies -> (список)
Политики приложения описывают, для чего может использоваться сертификат.
(структура помеченных союзов)
Политики приложения описывают, для чего может использоваться сертификат.
Примечание
Это структура помеченных союзов. Только один из следующих верхнеуровневых ключей может быть установлен:PolicyObjectIdentifier, PolicyType.PolicyObjectIdentifier -> (строка)
PolicyType -> (строка)
KeyUsage -> (структура)
Расширение использования ключей определяет назначение (например, шифрование, подпись, подписание сертификатов) ключа, содержащегося в сертификате.
Critical -> (булево)
UsageFlags -> (структура)
Флаги использования ключа представляют назначение (например, шифрование, подпись) ключа, содержащегося в сертификате.
DataEncipherment -> (булево)
DigitalSignature -> (булево)
KeyAgreement -> (булево)
KeyEncipherment -> (булево)
NonRepudiation -> (булево)
GeneralFlags -> (структура)
Общие флаги описывают, используется ли шаблон для компьютеров или пользователей, и можно ли использовать шаблон с автоматической регистрацией.
AutoEnrollment -> (булево)
MachineType -> (булево)
PrivateKeyAttributes -> (структура)
Атрибуты закрытого ключа позволяют указать минимальную длину ключа, спецификацию ключа и криптографические поставщики для закрытого ключа сертификата для шаблонов v2. Шаблоны v2 позволяют использовать устаревшие криптографические поставщики.
CryptoProviders -> (список)
Определяет криптографические поставщики, используемые для генерации закрытого ключа.
(строка)
KeySpec -> (строка)
MinimalKeyLength -> (целое число)
PrivateKeyFlags -> (структура)
Флаги закрытого ключа для шаблонов v2 задают совместимость клиента, возможность экспорта закрытого ключа и необходимость ввода пользователем при использовании закрытого ключа.
ClientVersion -> (строка)
ExportableKey -> (булево)
StrongKeyProtectionRequired -> (булево)
SubjectNameFlags -> (структура)
Флаги имени субъекта описывают имя субъекта и альтернативное имя субъекта, которое включено в сертификат.
RequireCommonName -> (булево)
RequireDirectoryPath -> (булево)
RequireDnsAsCn -> (булево)
RequireEmail -> (булево)
SanRequireDirectoryGuid -> (булево)
SanRequireDns -> (булево)
SanRequireDomainDns -> (булево)
SanRequireEmail -> (булево)
SanRequireSpn -> (булево)
SanRequireUpn -> (булево)
SupersededTemplates -> (список)
Список шаблонов в Active Directory, которые устарели по отношению к этому шаблону.
(строка)
TemplateV3 -> (структура)
Настройка шаблона для определения информации, включенной в сертификаты. Определите срок действия и периоды продления сертификатов, обработку запросов на сертификаты и параметры регистрации, расширения использования ключа, политики приложения и параметры криптографии.
CertificateValidity -> (структура)
Срок действия сертификата описывает срок действия и периоды продления сертификата.
RenewalPeriod -> (структура)
Срок продления — это период времени до истечения срока действия сертификата, когда будет запрошен новый сертификат.
Period -> (длинное целое число)
PeriodType -> (строка)
ValidityPeriod -> (структура)
Информация, описывающая окончание срока действия сертификата. Этот параметр устанавливает дату «Не позже» для сертификата. Срок действия сертификата — это период времени, в течение которого сертификат действителен. Срок действия может быть выражен явной датой и временем истечения срока действия сертификата или как период времени после выдачи, указанный в днях, месяцах или годах. Дополнительную информацию см. в разделе «Действительность» в RFC 5280. Это значение не меняется, когда также указано ValidityNotBefore. Например, если Validity установлен на 20 дней в будущем, сертификат истечет через 20 дней с момента выдачи независимо от значения ValidityNotBefore.
Period -> (длинное целое число)
PeriodType -> (строка)
EnrollmentFlags -> (структура)
Флаги регистрации описывают параметры регистрации сертификатов, такие как использование существующего закрытого ключа и удаление просроченных или отозванных сертификатов.
EnableKeyReuseOnNtTokenKeysetStorageFull -> (булево)
IncludeSymmetricAlgorithms -> (булево)
NoSecurityExtension -> (булево)
RemoveInvalidCertificateFromPersonalStore -> (булево)
UserInteractionRequired -> (булево)
Extensions -> (структура)
Расширения описывают расширения использования ключа и политики приложения для шаблона.
ApplicationPolicies -> (структура)
Политики приложения указывают, для чего используется сертификат и его назначение.
Critical -> (булево)
Policies -> (список)
Политики приложения описывают, для чего может использоваться сертификат.
(структура помеченного союза)
Политики приложения описывают, для чего может использоваться сертификат.
Примечание
Это структура помеченного союза. Можно установить только один из следующих верхних ключей:PolicyObjectIdentifier, PolicyType.PolicyObjectIdentifier -> (строка)
PolicyType -> (строка)
KeyUsage -> (структура)
Расширение использования ключа определяет назначение (например, шифрование, подпись, подпись сертификата) ключа, содержащегося в сертификате.
Critical -> (булево)
UsageFlags -> (структура)
Флаги использования ключа представляют назначение (например, шифрование, подпись) ключа, содержащегося в сертификате.
DataEncipherment -> (булево)
DigitalSignature -> (булево)
KeyAgreement -> (булево)
KeyEncipherment -> (булево)
NonRepudiation -> (булево)
GeneralFlags -> (структура)
Общие флаги описывают, используется ли шаблон для компьютеров или пользователей, и можно ли использовать шаблон с автоматической регистрацией.
AutoEnrollment -> (булево)
MachineType -> (булево)
HashAlgorithm -> (строка)
PrivateKeyAttributes -> (структура)
Атрибуты закрытого ключа позволяют задать алгоритм, минимальную длину ключа, спецификацию ключа, использование ключа и криптографические поставщики для закрытого ключа сертификата для шаблонов v3. Шаблоны v3 позволяют использовать поставщиков хранения ключей.
Algorithm -> (строка)
CryptoProviders -> (список)
Определяет криптографические поставщики, используемые для генерации закрытого ключа.
(строка)
KeySpec -> (строка)
KeyUsageProperty -> (структура помеченного союза)
Свойство использования ключа определяет назначение закрытого ключа, содержащегося в сертификате. Вы можете указать конкретные назначения, используя флаги свойства или все, используя тип свойства ALL.
Примечание
Это структура помеченного союза. Можно установить только один из следующих верхних ключей:PropertyFlags, PropertyType.PropertyFlags -> (структура)
Вы можете указать использование ключа для шифрования, согласования ключей и подписи. Вы можете использовать флаги свойств или тип свойства, но не оба.
Decrypt -> (булево)
KeyAgreement -> (булево)
Sign -> (булево)
PropertyType -> (строка)
MinimalKeyLength -> (целое число)
PrivateKeyFlags -> (структура)
Флаги закрытого ключа для шаблонов v3 определяют совместимость клиента, можно ли экспортировать закрытый ключ, требуется ли ввод пользователя при использовании закрытого ключа и следует ли использовать альтернативный алгоритм подписи.
ClientVersion -> (строка)
ExportableKey -> (булево)
RequireAlternateSignatureAlgorithm -> (булево)
StrongKeyProtectionRequired -> (булево)
SubjectNameFlags -> (структура)
Флаги имени субъекта описывают имя субъекта и альтернативное имя субъекта, которые включаются в сертификат.
RequireCommonName -> (булево)
RequireDirectoryPath -> (булево)
RequireDnsAsCn -> (булево)
RequireEmail -> (булево)
SanRequireDirectoryGuid -> (булево)
SanRequireDns -> (булево)
SanRequireDomainDns -> (булево)
SanRequireEmail -> (булево)
SanRequireSpn -> (булево)
SanRequireUpn -> (булево)
SupersededTemplates -> (список)
Список шаблонов в Active Directory, которые устарели благодаря этому шаблону.
(строка)
TemplateV4 -> (структура)
Настройка шаблона для определения информации, включаемой в сертификаты. Определяет срок действия и периоды продления сертификатов, обработку запросов на сертификаты и варианты регистрации, расширения использования ключей, политики приложений и параметры криптографии.
CertificateValidity -> (структура)
Срок действия сертификата описывает срок действия и периоды продления сертификата.
RenewalPeriod -> (структура)
Период продления — это период времени до истечения срока действия сертификата, когда будет запрошен новый сертификат.
Period -> (long)
PeriodType -> (строка)
ValidityPeriod -> (структура)
Информация, описывающая окончание срока действия сертификата. Этот параметр устанавливает дату «Не после» для сертификата. Срок действия сертификата — это период времени, в течение которого сертификат действителен. Срок действия может быть выражен как явная дата и время истечения срока действия сертификата или как период времени после выпуска, указанный в днях, месяцах или годах. Для получения дополнительной информации см. Действие в RFC 5280. Это значение не изменяется, когда также указан ValidityNotBefore. Например, если срок действия установлен на 20 дней в будущем, сертификат истечет через 20 дней после выпуска, независимо от значения ValidityNotBefore.
Period -> (long)
PeriodType -> (строка)
EnrollmentFlags -> (структура)
Флаги регистрации описывают параметры регистрации сертификатов с использованием существующего закрытого ключа и удаление истекших или отозванных сертификатов.
EnableKeyReuseOnNtTokenKeysetStorageFull -> (булево)
IncludeSymmetricAlgorithms -> (булево)
NoSecurityExtension -> (булево)
RemoveInvalidCertificateFromPersonalStore -> (булево)
UserInteractionRequired -> (булево)
Extensions -> (структура)
Расширения описывают расширения использования ключей и политики приложений для шаблона.
ApplicationPolicies -> (структура)
Политики приложений указывают, для чего используется сертификат и его назначение.
Critical -> (булево)
Policies -> (список)
Политики приложений описывают, для чего может использоваться сертификат.
(структура помеченного объединения)
Политики приложений описывают, для чего может использоваться сертификат.
Примечание
Это структура помеченного объединения. Только один из следующих верхних ключей может быть установлен:PolicyObjectIdentifier, PolicyType.PolicyObjectIdentifier -> (строка)
PolicyType -> (строка)
KeyUsage -> (структура)
Расширение использования ключа определяет назначение (например, шифрование, цифровая подпись) ключа, содержащегося в сертификате.
Critical -> (булево)
UsageFlags -> (структура)
Флаги использования ключа представляют назначение (например, шифрование, цифровая подпись) ключа, содержащегося в сертификате.
DataEncipherment -> (булево)
DigitalSignature -> (булево)
KeyAgreement -> (булево)
KeyEncipherment -> (булево)
NonRepudiation -> (булево)
GeneralFlags -> (структура)
Общие флаги описывают, используется ли шаблон для компьютеров или пользователей, и можно ли использовать шаблон с автоматической регистрацией.
AutoEnrollment -> (булево)
MachineType -> (булево)
HashAlgorithm -> (строка)
PrivateKeyAttributes -> (структура)
Атрибуты закрытого ключа позволяют указать минимальную длину ключа, спецификацию ключа, использование ключа и криптографические поставщики для закрытого ключа сертификата для шаблонов v4. Шаблоны v4 позволяют использовать либо поставщиков хранилищ ключей, либо поставщиков криптографических служб Legacy. Вы указываете категорию поставщика криптографии в флагах закрытого ключа.
Algorithm -> (строка)
CryptoProviders -> (список)
Определяет криптографические поставщики, используемые для генерации закрытого ключа.
(строка)
KeySpec -> (строка)
KeyUsageProperty -> (структура помеченного объединения)
Свойство использования ключа определяет назначение закрытого ключа, содержащегося в сертификате. Вы можете указать конкретные цели с помощью флагов свойств или все с помощью типа свойства ALL.
Примечание
Это структура помеченного объединения. Только один из следующих верхних ключей может быть установлен:PropertyFlags, PropertyType.PropertyFlags -> (структура)
Вы можете указать использование ключа для шифрования, согласования ключей и цифровой подписи. Вы можете использовать флаги свойств или тип свойства, но не оба.
Decrypt -> (булево)
KeyAgreement -> (булево)
Sign -> (булево)
PropertyType -> (строка)
MinimalKeyLength -> (целое число)
PrivateKeyFlags -> (структура)
Флаги закрытого ключа для шаблонов v4 определяют совместимость клиента, можно ли экспортировать закрытый ключ, требуется ли ввод пользователя при использовании закрытого ключа, следует ли использовать альтернативный алгоритм подписи и продлеваются ли сертификаты с использованием того же закрытого ключа.
ClientVersion -> (строка)
ExportableKey -> (булево)
RequireAlternateSignatureAlgorithm -> (булево)
RequireSameKeyRenewal -> (булево)
StrongKeyProtectionRequired -> (булево)
UseLegacyProvider -> (булево)
SubjectNameFlags -> (структура)
Флаги имени субъекта описывают имя субъекта и альтернативное имя субъекта, которые включаются в сертификат.
RequireCommonName -> (булево)
RequireDirectoryPath -> (булево)
RequireDnsAsCn -> (булево)
RequireEmail -> (булево)
SanRequireDirectoryGuid -> (булево)
SanRequireDns -> (булево)
SanRequireDomainDns -> (булево)
SanRequireEmail -> (булево)
SanRequireSpn -> (булево)
SanRequireUpn -> (булево)
SupersededTemplates -> (список)
Список шаблонов в Active Directory, которые устарели по отношению к этому шаблону.
(строка)
Name -> (строка)
ObjectIdentifier -> (строка)
PolicySchema -> (целое число)
Revision -> (структура)
Версия шаблона. Обновления шаблонов будут увеличивать второстепенную ревизию. Перезапись всех держателей сертификатов увеличит основную ревизию.
MajorRevision -> (целое число)
MinorRevision -> (целое число)
Status -> (строка)
UpdatedAt -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.