Class: Aws::CloudControlApi::Types::UpdateResourceInput

Inherits:

Struct

• Object
• Struct
• Aws::CloudControlApi::Types::UpdateResourceInput

Includes:

Structure

Defined in:

lib/aws-sdk-cloudcontrolapi/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:patch_document]

Instance Attribute Summary

• #client_token ⇒ String

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

• #identifier ⇒ String

  The identifier for the resource.

• #patch_document ⇒ String

  A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties.

• #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 1069

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

#identifier ⇒ String

The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values *in the order they are specified* in the primary identifier definition, separated by ‘|`.

For more information, see [Identifying resources] in the *Amazon Web Services Cloud Control API User Guide*.

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

Returns:

• (String)

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

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

#patch_document ⇒ String

A JavaScript Object Notation (JSON) document listing the patch operations that represent the updates to apply to the current resource properties. For details, see [Composing the patch document] in the *Amazon Web Services Cloud Control API User Guide*.

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

Returns:

• (String)

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

class UpdateResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :client_token,
  :identifier,
  :patch_document)
  SENSITIVE = [:patch_document]
  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 1069

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

#type_name ⇒ String

The name of the resource type.

Returns:

• (String)

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

class UpdateResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :client_token,
  :identifier,
  :patch_document)
  SENSITIVE = [:patch_document]
  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 1069

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