Class: Aws::Backup::Types::CreateFrameworkInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::CreateFrameworkInput
- Defined in:
- gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb
Overview
When making an API call, you may pass CreateFrameworkInput data as a hash:
{
framework_name: "FrameworkName", # required
framework_description: "FrameworkDescription",
framework_controls: [ # required
{
control_name: "ControlName", # required
control_input_parameters: [
{
parameter_name: "ParameterName",
parameter_value: "ParameterValue",
},
],
control_scope: {
compliance_resource_ids: ["string"],
compliance_resource_types: ["ARN"],
tags: {
"string" => "string",
},
},
},
],
idempotency_token: "string",
framework_tags: {
"string" => "string",
},
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#framework_controls ⇒ Array<Types::FrameworkControl>
A list of the controls that make up the framework.
-
#framework_description ⇒ String
An optional description of the framework with a maximum of 1,024 characters.
-
#framework_name ⇒ String
The unique name of the framework.
-
#framework_tags ⇒ Hash<String,String>
Metadata that you can assign to help organize the frameworks that you create.
-
#idempotency_token ⇒ String
A customer-chosen string that you can use to distinguish between otherwise identical calls to
CreateFrameworkInput
.
Instance Attribute Details
#framework_controls ⇒ Array<Types::FrameworkControl>
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
1766 1767 1768 1769 1770 1771 1772 1773 1774 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1766 class CreateFrameworkInput < Struct.new( :framework_name, :framework_description, :framework_controls, :idempotency_token, :framework_tags) SENSITIVE = [] include Aws::Structure end |
#framework_description ⇒ String
An optional description of the framework with a maximum of 1,024 characters.
1766 1767 1768 1769 1770 1771 1772 1773 1774 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1766 class CreateFrameworkInput < Struct.new( :framework_name, :framework_description, :framework_controls, :idempotency_token, :framework_tags) SENSITIVE = [] include Aws::Structure end |
#framework_name ⇒ String
The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
1766 1767 1768 1769 1770 1771 1772 1773 1774 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1766 class CreateFrameworkInput < Struct.new( :framework_name, :framework_description, :framework_controls, :idempotency_token, :framework_tags) SENSITIVE = [] include Aws::Structure end |
#framework_tags ⇒ Hash<String,String>
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
1766 1767 1768 1769 1770 1771 1772 1773 1774 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1766 class CreateFrameworkInput < Struct.new( :framework_name, :framework_description, :framework_controls, :idempotency_token, :framework_tags) SENSITIVE = [] include Aws::Structure end |
#idempotency_token ⇒ String
A customer-chosen string that you can use to distinguish between
otherwise identical calls to CreateFrameworkInput
. Retrying a
successful request with the same idempotency token results in a
success message with no action taken.
A suitable default value is auto-generated. You should normally not need to pass this option.
1766 1767 1768 1769 1770 1771 1772 1773 1774 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1766 class CreateFrameworkInput < Struct.new( :framework_name, :framework_description, :framework_controls, :idempotency_token, :framework_tags) SENSITIVE = [] include Aws::Structure end |