Class: Aws::SecurityHub::Types::AwsSecretsManagerSecretDetails

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsSecretsManagerSecretDetails

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

When making an API call, you may pass AwsSecretsManagerSecretDetails data as a hash:

{
  rotation_rules: {
    automatically_after_days: 1,
  },
  rotation_occurred_within_frequency: false,
  kms_key_id: "NonEmptyString",
  rotation_enabled: false,
  rotation_lambda_arn: "NonEmptyString",
  deleted: false,
  name: "NonEmptyString",
  description: "NonEmptyString",
}

Details about an Secrets Manager secret.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #deleted ⇒ Boolean

  Whether the secret is deleted.

• #description ⇒ String

  The user-provided description of the secret.

• #kms_key_id ⇒ String

  The ARN, Key ID, or alias of the KMS key used to encrypt the SecretString or SecretBinary values for versions of this secret.

• #name ⇒ String

  The name of the secret.

• #rotation_enabled ⇒ Boolean

  Whether rotation is enabled.

• #rotation_lambda_arn ⇒ String

  The ARN of the Lambda function that rotates the secret.

• #rotation_occurred_within_frequency ⇒ Boolean

  Whether the rotation occurred within the specified rotation frequency.

• #rotation_rules ⇒ Types::AwsSecretsManagerSecretRotationRules

  Defines the rotation schedule for the secret.

Instance Attribute Details

#deleted ⇒ Boolean

Whether the secret is deleted.

Returns:

• (Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 19291

class AwsSecretsManagerSecretDetails < Struct.new(
  :rotation_rules,
  :rotation_occurred_within_frequency,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :deleted,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The user-provided description of the secret.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 19291

class AwsSecretsManagerSecretDetails < Struct.new(
  :rotation_rules,
  :rotation_occurred_within_frequency,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :deleted,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The ARN, Key ID, or alias of the KMS key used to encrypt the SecretString or SecretBinary values for versions of this secret.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 19291

class AwsSecretsManagerSecretDetails < Struct.new(
  :rotation_rules,
  :rotation_occurred_within_frequency,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :deleted,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the secret.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 19291

class AwsSecretsManagerSecretDetails < Struct.new(
  :rotation_rules,
  :rotation_occurred_within_frequency,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :deleted,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_enabled ⇒ Boolean

Whether rotation is enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 19291

class AwsSecretsManagerSecretDetails < Struct.new(
  :rotation_rules,
  :rotation_occurred_within_frequency,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :deleted,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_lambda_arn ⇒ String

The ARN of the Lambda function that rotates the secret.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 19291

class AwsSecretsManagerSecretDetails < Struct.new(
  :rotation_rules,
  :rotation_occurred_within_frequency,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :deleted,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_occurred_within_frequency ⇒ Boolean

Whether the rotation occurred within the specified rotation frequency.

Returns:

• (Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 19291

class AwsSecretsManagerSecretDetails < Struct.new(
  :rotation_rules,
  :rotation_occurred_within_frequency,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :deleted,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_rules ⇒ Types::AwsSecretsManagerSecretRotationRules

Defines the rotation schedule for the secret.

Returns:

• (Types::AwsSecretsManagerSecretRotationRules)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 19291

class AwsSecretsManagerSecretDetails < Struct.new(
  :rotation_rules,
  :rotation_occurred_within_frequency,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :deleted,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end