Class: Aws::DSQL::Types::UpdateClusterInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

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

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 1190

class UpdateClusterInput < Struct.new(
  :identifier,
  :deletion_protection_enabled,
  :kms_encryption_key,
  :client_token,
  :multi_region_properties,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ Boolean

Specifies whether to enable deletion protection in your cluster.

Returns:

  • (Boolean)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 1190

class UpdateClusterInput < Struct.new(
  :identifier,
  :deletion_protection_enabled,
  :kms_encryption_key,
  :client_token,
  :multi_region_properties,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ String

The ID of the cluster you want to update.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 1190

class UpdateClusterInput < Struct.new(
  :identifier,
  :deletion_protection_enabled,
  :kms_encryption_key,
  :client_token,
  :multi_region_properties,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#kms_encryption_key ⇒ String

The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.

To switch to the key owned by Amazon Web Services, specify the reserved value AWS_OWNED_KMS_KEY.

Returns:

  • (String)


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 1190

class UpdateClusterInput < Struct.new(
  :identifier,
  :deletion_protection_enabled,
  :kms_encryption_key,
  :client_token,
  :multi_region_properties,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#metric_groups ⇒ Array<Types::MetricGroupRequest>

The complete set of metric groups to enable for advanced monitoring on the cluster. This list replaces the current set, so any metric group that you don't include is disabled. To disable all metric groups, specify an empty list ([]). If you omit this parameter, the current setting doesn't change.

To view the metric groups enabled on a cluster, use GetCluster.

Returns:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 1190

class UpdateClusterInput < Struct.new(
  :identifier,
  :deletion_protection_enabled,
  :kms_encryption_key,
  :client_token,
  :multi_region_properties,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region_properties ⇒ Types::MultiRegionProperties

The new multi-Region cluster configuration settings to be applied during an update operation.



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 1190

class UpdateClusterInput < Struct.new(
  :identifier,
  :deletion_protection_enabled,
  :kms_encryption_key,
  :client_token,
  :multi_region_properties,
  :metric_groups)
  SENSITIVE = []
  include Aws::Structure
end