Skip to content

Create Resource

cloudcontrolapi_create_resource R Documentation

Creates the specified resource

Description

Creates the specified resource. For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource creation request, you can monitor the progress of your request by calling get_resource_request_status using the RequestToken of the ProgressEvent type returned by create_resource.

Usage

cloudcontrolapi_create_resource(TypeName, TypeVersionId, RoleArn,
  ClientToken, DesiredState)

Arguments

TypeName

[required] The name of the resource type.

TypeVersionId

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

RoleArn

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

ClientToken

A unique identifier to ensure the idempotency of the resource request. As a best practice, specify this token to ensure idempotency, so that Amazon Web Services Cloud Control API can accurately distinguish between request retries and new resource requests. You might retry a resource request to ensure that it was successfully received.

A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request.

If you do not specify a client token, one is generated for inclusion in the request.

For more information, see Ensuring resource operation requests are unique in the Amazon Web Services Cloud Control API User Guide.

DesiredState

[required] Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.

Cloud Control API currently supports JSON as a structured data format.

Specify the desired state as one of the following:

  • A JSON blob

  • A local path containing the desired state in JSON data format

For more information, see Composing the desired state of the resource in the Amazon Web Services Cloud Control API User Guide.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.

Value

A list with the following syntax: 

list(
  ProgressEvent = list(
    TypeName = "string",
    Identifier = "string",
    RequestToken = "string",
    Operation = "CREATE"|"DELETE"|"UPDATE",
    OperationStatus = "PENDING"|"IN_PROGRESS"|"SUCCESS"|"FAILED"|"CANCEL_IN_PROGRESS"|"CANCEL_COMPLETE",
    EventTime = as.POSIXct(
      "2015-01-01"
    ),
    ResourceModel = "string",
    StatusMessage = "string",
    ErrorCode = "NotUpdatable"|"InvalidRequest"|"AccessDenied"|"InvalidCredentials"|"AlreadyExists"|"NotFound"|"ResourceConflict"|"Throttling"|"ServiceLimitExceeded"|"NotStabilized"|"GeneralServiceException"|"ServiceInternalError"|"ServiceTimeout"|"NetworkFailure"|"InternalFailure",
    RetryAfter = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$create_resource(
  TypeName = "string",
  TypeVersionId = "string",
  RoleArn = "string",
  ClientToken = "string",
  DesiredState = "string"
)