Class: MintPress::Aws::Route53::KeySigningKey

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb

Properties (Read/Write)

  • #created_date ⇒ [Time]
    'The date when the key signing key (KSK) was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'created_date'
    

20
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 20

property :created_date, disposition: :attribute, description: 'The date when the key signing key (KSK) was created.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'created_date', type: [Time]
  • #digest_algorithm_mnemonic ⇒ [String]
    'A string used to represent the delegation signer digest algorithm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'digest_algorithm_mnemonic'
    

21
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 21

property :digest_algorithm_mnemonic, disposition: :attribute, description: 'A string used to represent the delegation signer digest algorithm.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'digest_algorithm_mnemonic', type: [String]
  • #digest_algorithm_type ⇒ [Integer]
    'An integer used to represent the delegation signer digest algorithm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'digest_algorithm_type'
    

22
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 22

property :digest_algorithm_type, disposition: :attribute, description: 'An integer used to represent the delegation signer digest algorithm.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'digest_algorithm_type', type: [Integer]
  • #digest_value ⇒ [String]
    'A cryptographic digest of a DNSKEY resource record (RR).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'digest_value'
    

23
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 23

property :digest_value, disposition: :attribute, description: 'A cryptographic digest of a DNSKEY resource record (RR).', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'digest_value', type: [String]
  • #dnskey_record ⇒ [String]
    'A string that represents a DNSKEY record.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'dnskey_record'
    

24
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 24

property :dnskey_record, disposition: :attribute, description: 'A string that represents a DNSKEY record.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'dnskey_record', type: [String]
  • #ds_record ⇒ [String]
    'A string that represents a delegation signer (DS) record.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'ds_record'
    

25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 25

property :ds_record, disposition: :attribute, description: 'A string that represents a delegation signer (DS) record.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'ds_record', type: [String]
  • #flag ⇒ [Integer]
    'An integer that specifies how the key is used.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'flag'
    

26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 26

property :flag, disposition: :attribute, description: 'An integer that specifies how the key is used.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'flag', type: [Integer]
  • #key_tag ⇒ [Integer]
    'An integer used to identify the DNSSEC record for the domain name.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'key_tag'
    

27
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 27

property :key_tag, disposition: :attribute, description: 'An integer used to identify the DNSSEC record for the domain name.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'key_tag', type: [Integer]
  • #kms_arn ⇒ [String]
    'The Amazon resource name (ARN) used to identify the customer managed key (CMK) in AWS Key Management Service (KMS).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'kms_arn'
    

28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 28

property :kms_arn, disposition: :attribute, description: 'The Amazon resource name (ARN) used to identify the customer managed key (CMK) in AWS Key Management Service (KMS).', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'kms_arn', type: [String]
  • #last_modified_date ⇒ [Time]
    'The last time that the key signing key (KSK) was changed.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'last_modified_date'
    

29
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 29

property :last_modified_date, disposition: :attribute, description: 'The last time that the key signing key (KSK) was changed.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'last_modified_date', type: [Time]
  • #name ⇒ [String]
    'An alphanumeric string used to identify a key signing key (KSK).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'name'
    • create_key_signing_key_prop ⇒ 'name'
    • read_only ⇒ false
    • delete_key_signing_key_prop ⇒ 'name'
    

30
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 30

property :name, disposition: :attribute, description: 'An alphanumeric string used to identify a key signing key (KSK).', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'name', type: [String], create_key_signing_key_prop: 'name', read_only: false, delete_key_signing_key_prop: 'name'
  • #public_key ⇒ [String]
    'The public key, represented as a Base64 encoding, as required by [ RFC-4034 Page 5][1].'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'public_key'
    

31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 31

property :public_key, disposition: :attribute, description: 'The public key, represented as a Base64 encoding, as required by [ RFC-4034 Page 5][1].', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'public_key', type: [String]
  • #signing_algorithm_mnemonic ⇒ [String]
    'A string used to represent the signing algorithm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'signing_algorithm_mnemonic'
    

32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 32

property :signing_algorithm_mnemonic, disposition: :attribute, description: 'A string used to represent the signing algorithm.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'signing_algorithm_mnemonic', type: [String]
  • #signing_algorithm_type ⇒ [Integer]
    'An integer used to represent the signing algorithm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'signing_algorithm_type'
    

33
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 33

property :signing_algorithm_type, disposition: :attribute, description: 'An integer used to represent the signing algorithm.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'signing_algorithm_type', type: [Integer]
  • #status ⇒ [String]
    'A string that represents the current key signing key (KSK) status.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'status'
    • create_key_signing_key_prop ⇒ 'status'
    • read_only ⇒ false
    

34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 34

property :status, disposition: :attribute, description: 'A string that represents the current key signing key (KSK) status.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'status', type: [String], create_key_signing_key_prop: 'status', read_only: false
  • #status_message ⇒ [String]
    'The status message provided for the following key signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Route53::KeySigningKey"
    • orig_name ⇒ 'status_message'
    

35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 35

property :status_message, disposition: :attribute, description: 'The status message provided for the following key signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE.', source: "MintPress::Aws::Route53::KeySigningKey", orig_name: 'status_message', type: [String]
  • #caller_reference ⇒ [String]
    'A unique string that identifies the request.'
    Property Attributes
    • create_key_signing_key_prop ⇒ 'caller_reference'
    • read_only ⇒ false
    • source ⇒ "create_key_signing_key"
    

36
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 36

property :caller_reference, create_key_signing_key_prop: 'caller_reference', type: [String], read_only: false, source: "create_key_signing_key", description: 'A unique string that identifies the request.'
  • #key_management_service_arn ⇒ [String]
    'The Amazon resource name (ARN) for a customer managed key (CMK) in AWS Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, scroll down to Example. You must configure the CMK as follows: Status Enabled Key spec ECC_NIST_P256 Key usage Sign and verify Key policy The key policy must give permission for the following actions: DescribeKey GetPublicKey Sign The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following: "Service": "api-service.dnssec.route53.aws.internal" ^ For more information about working with CMK in KMS, see AWS Key Management Service concepts.'
    Property Attributes
    • create_key_signing_key_prop ⇒ 'key_management_service_arn'
    • read_only ⇒ false
    • source ⇒ "create_key_signing_key"
    

37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 37

property :key_management_service_arn, create_key_signing_key_prop: 'key_management_service_arn', type: [String], read_only: false, source: "create_key_signing_key", description: 'The Amazon resource name (ARN) for a customer managed key (CMK) in AWS
Key Management Service (KMS). The KeyManagementServiceArn must be
unique for each key signing key (KSK) in a single hosted zone. To see
an example of KeyManagementServiceArn that grants the correct
permissions for DNSSEC, scroll down to Example.

You must configure the CMK as follows:


Status
Enabled
Key spec
ECC_NIST_P256
Key usage
Sign and verify
Key policy
The key policy must give permission for the following actions:


DescribeKey
GetPublicKey
Sign



The key policy must also include the Amazon Route 53 service in the
principal for your account. Specify the following:


"Service": "api-service.dnssec.route53.aws.internal"



^


For more information about working with CMK in KMS, see AWS Key
Management Service concepts.'
  • #hosted_zone ⇒ [MintPress::Aws::Route53::HostedZone]
    'A unique string used to identify a hosted zone.'
    Property Attributes
    • create_key_signing_key_prop ⇒ 'hosted_zone_id'
    • read_only ⇒ false
    • source ⇒ "delete_key_signing_key"
    • delete_key_signing_key_prop ⇒ 'hosted_zone_id'
    • from ⇒ String
    

75
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 75

property :hosted_zone, create_key_signing_key_prop: 'hosted_zone_id', type: [MintPress::Aws::Route53::HostedZone], read_only: false, source: "delete_key_signing_key", description: 'A unique string used to identify a hosted zone.', delete_key_signing_key_prop: 'hosted_zone_id', from: String
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

79
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 79

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

82
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/route53/key_signing_key.rb', line 82

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ KeySigningKey

Returns a new instance of KeySigningKey.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object