Class: Aws::CloudControlApi::Types::CreateResourceInput

Inherits:

Struct

• Object
• Struct
• Aws::CloudControlApi::Types::CreateResourceInput

Includes:

Structure

Defined in:

lib/aws-sdk-cloudcontrolapi/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:desired_state]

Instance Attribute Summary

• #client_token ⇒ String

  A unique identifier to ensure the idempotency of the resource request.

• #desired_state ⇒ String

  Structured data format representing the desired state of the resource, consisting of that resource’s properties and their desired values.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation.

• #type_name ⇒ String

  The name of the resource type.

• #type_version_id ⇒ String

  For private resource types, the type version to use in this resource operation.

Instance Attribute Details

#client_token ⇒ String

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*.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 190

class CreateResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :client_token,
  :desired_state)
  SENSITIVE = [:desired_state]
  include Aws::Structure
end

#desired_state ⇒ String

Structured data format representing the desired state of the resource, consisting of that resource’s properties and their desired values.

<note markdown=“1”> Cloud Control API currently supports JSON as a structured data format.

</note>

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*.

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 190

class CreateResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :client_token,
  :desired_state)
  SENSITIVE = [:desired_state]
  include Aws::Structure
end

#role_arn ⇒ String

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*.

[1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 190

class CreateResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :client_token,
  :desired_state)
  SENSITIVE = [:desired_state]
  include Aws::Structure
end

#type_name ⇒ String

The name of the resource type.

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 190

class CreateResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :client_token,
  :desired_state)
  SENSITIVE = [:desired_state]
  include Aws::Structure
end

#type_version_id ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 190

class CreateResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :client_token,
  :desired_state)
  SENSITIVE = [:desired_state]
  include Aws::Structure
end