Class: Aws::DSQL::Types::CreateClusterInput

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

#bypass_policy_lockout_safety_check ⇒ Boolean

An optional field that controls whether to bypass the lockout prevention check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.

Returns:

  • (Boolean)


124
125
126
127
128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 124

class CreateClusterInput < Struct.new(
  :deletion_protection_enabled,
  :kms_encryption_key,
  :tags,
  :client_token,
  :multi_region_properties,
  :policy,
  :metric_groups,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end

#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)


124
125
126
127
128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 124

class CreateClusterInput < Struct.new(
  :deletion_protection_enabled,
  :kms_encryption_key,
  :tags,
  :client_token,
  :multi_region_properties,
  :policy,
  :metric_groups,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ Boolean

If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.

Returns:

  • (Boolean)


124
125
126
127
128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 124

class CreateClusterInput < Struct.new(
  :deletion_protection_enabled,
  :kms_encryption_key,
  :tags,
  :client_token,
  :multi_region_properties,
  :policy,
  :metric_groups,
  :bypass_policy_lockout_safety_check)
  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.

Returns:

  • (String)


124
125
126
127
128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 124

class CreateClusterInput < Struct.new(
  :deletion_protection_enabled,
  :kms_encryption_key,
  :tags,
  :client_token,
  :multi_region_properties,
  :policy,
  :metric_groups,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end

#metric_groups ⇒ Array<Types::MetricGroupRequest>

The metric groups to enable for advanced monitoring on the cluster. Advanced monitoring collects detailed, query-level database metrics to help you analyze and resolve performance issues. If you omit this parameter, no metric groups are enabled.

Returns:



124
125
126
127
128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 124

class CreateClusterInput < Struct.new(
  :deletion_protection_enabled,
  :kms_encryption_key,
  :tags,
  :client_token,
  :multi_region_properties,
  :policy,
  :metric_groups,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region_properties ⇒ Types::MultiRegionProperties

The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.



124
125
126
127
128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 124

class CreateClusterInput < Struct.new(
  :deletion_protection_enabled,
  :kms_encryption_key,
  :tags,
  :client_token,
  :multi_region_properties,
  :policy,
  :metric_groups,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end

#policy ⇒ String

An optional resource-based policy document in JSON format that defines access permissions for the cluster.

Returns:

  • (String)


124
125
126
127
128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 124

class CreateClusterInput < Struct.new(
  :deletion_protection_enabled,
  :kms_encryption_key,
  :tags,
  :client_token,
  :multi_region_properties,
  :policy,
  :metric_groups,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map of key and value pairs to use to tag your cluster.

Returns:

  • (Hash<String,String>)


124
125
126
127
128
129
130
131
132
133
134
135
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 124

class CreateClusterInput < Struct.new(
  :deletion_protection_enabled,
  :kms_encryption_key,
  :tags,
  :client_token,
  :multi_region_properties,
  :policy,
  :metric_groups,
  :bypass_policy_lockout_safety_check)
  SENSITIVE = []
  include Aws::Structure
end