cloudformation_describe_type: Returns detailed information about a type that has been...

Description Usage Arguments Value Request syntax

View source: R/cloudformation_operations.R

Description

Returns detailed information about a type that has been registered.

If you specify a VersionId, describe_type returns information about that specific type version. Otherwise, it returns information about the default type version.

Usage

1
cloudformation_describe_type(Type, TypeName, Arn, VersionId)

Arguments

Type

The kind of type.

Currently the only valid value is RESOURCE.

Conditional: You must specify either TypeName and Type, or Arn.

TypeName

The name of the type.

Conditional: You must specify either TypeName and Type, or Arn.

Arn

The Amazon Resource Name (ARN) of the type.

Conditional: You must specify either TypeName and Type, or Arn.

VersionId

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

If you specify a VersionId, describe_type returns information about that specific type version. Otherwise, it returns information about the default type version.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
list(
  Arn = "string",
  Type = "RESOURCE"|"MODULE",
  TypeName = "string",
  DefaultVersionId = "string",
  IsDefaultVersion = TRUE|FALSE,
  Description = "string",
  Schema = "string",
  ProvisioningType = "NON_PROVISIONABLE"|"IMMUTABLE"|"FULLY_MUTABLE",
  DeprecatedStatus = "LIVE"|"DEPRECATED",
  LoggingConfig = list(
    LogRoleArn = "string",
    LogGroupName = "string"
  ),
  ExecutionRoleArn = "string",
  Visibility = "PUBLIC"|"PRIVATE",
  SourceUrl = "string",
  DocumentationUrl = "string",
  LastUpdated = as.POSIXct(
    "2015-01-01"
  ),
  TimeCreated = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

1
2
3
4
5
6
svc$describe_type(
  Type = "RESOURCE"|"MODULE",
  TypeName = "string",
  Arn = "string",
  VersionId = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.