AWS Native is in preview. AWS Classic is fully supported.
aws-native.securityhub.SecurityControl
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
A security control in Security Hub describes a security best practice related to a specific resource.
Create SecurityControl Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SecurityControl(name: string, args: SecurityControlArgs, opts?: CustomResourceOptions);
@overload
def SecurityControl(resource_name: str,
args: SecurityControlArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SecurityControl(resource_name: str,
opts: Optional[ResourceOptions] = None,
parameters: Optional[Mapping[str, SecurityControlParameterConfigurationArgs]] = None,
last_update_reason: Optional[str] = None,
security_control_arn: Optional[str] = None,
security_control_id: Optional[str] = None)
func NewSecurityControl(ctx *Context, name string, args SecurityControlArgs, opts ...ResourceOption) (*SecurityControl, error)
public SecurityControl(string name, SecurityControlArgs args, CustomResourceOptions? opts = null)
public SecurityControl(String name, SecurityControlArgs args)
public SecurityControl(String name, SecurityControlArgs args, CustomResourceOptions options)
type: aws-native:securityhub:SecurityControl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SecurityControlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SecurityControlArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SecurityControlArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SecurityControlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SecurityControlArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
SecurityControl Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SecurityControl resource accepts the following input properties:
- Parameters
Dictionary<string, Pulumi.
Aws Native. Security Hub. Inputs. Security Control Parameter Configuration Args> - An object that identifies the name of a control parameter, its current value, and whether it has been customized.
- Last
Update stringReason - The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
- Security
Control stringArn - The Amazon Resource Name (ARN) for a security control across standards, such as
arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1
. This parameter doesn't mention a specific standard. - Security
Control stringId - The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3.
- Parameters
map[string]Security
Control Parameter Configuration Args - An object that identifies the name of a control parameter, its current value, and whether it has been customized.
- Last
Update stringReason - The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
- Security
Control stringArn - The Amazon Resource Name (ARN) for a security control across standards, such as
arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1
. This parameter doesn't mention a specific standard. - Security
Control stringId - The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3.
- parameters
Map<String,Security
Control Parameter Configuration Args> - An object that identifies the name of a control parameter, its current value, and whether it has been customized.
- last
Update StringReason - The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
- security
Control StringArn - The Amazon Resource Name (ARN) for a security control across standards, such as
arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1
. This parameter doesn't mention a specific standard. - security
Control StringId - The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3.
- parameters
{[key: string]: Security
Control Parameter Configuration Args} - An object that identifies the name of a control parameter, its current value, and whether it has been customized.
- last
Update stringReason - The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
- security
Control stringArn - The Amazon Resource Name (ARN) for a security control across standards, such as
arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1
. This parameter doesn't mention a specific standard. - security
Control stringId - The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3.
- parameters
Mapping[str, Security
Control Parameter Configuration Args] - An object that identifies the name of a control parameter, its current value, and whether it has been customized.
- last_
update_ strreason - The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
- security_
control_ strarn - The Amazon Resource Name (ARN) for a security control across standards, such as
arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1
. This parameter doesn't mention a specific standard. - security_
control_ strid - The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3.
- parameters Map<Property Map>
- An object that identifies the name of a control parameter, its current value, and whether it has been customized.
- last
Update StringReason - The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
- security
Control StringArn - The Amazon Resource Name (ARN) for a security control across standards, such as
arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1
. This parameter doesn't mention a specific standard. - security
Control StringId - The unique identifier of a security control across standards. Values for this field typically consist of an AWS service name and a number, such as APIGateway.3.
Outputs
All input properties are implicitly available as output properties. Additionally, the SecurityControl resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
SecurityControlParameterConfiguration, SecurityControlParameterConfigurationArgs
- Value
Type Pulumi.Aws Native. Security Hub. Security Control Parameter Configuration Value Type Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior.
When
ValueType
is set equal toDEFAULT
, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. WhenValueType
is set equal toDEFAULT
, Security Hub ignores user-provided input for theValue
field.When
ValueType
is set equal toCUSTOM
, theValue
field can't be empty.- Value
Pulumi.
Aws Native. Security Hub. Inputs. Security Control Parameter Value - The current value of a control parameter.
- Value
Type SecurityControl Parameter Configuration Value Type Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior.
When
ValueType
is set equal toDEFAULT
, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. WhenValueType
is set equal toDEFAULT
, Security Hub ignores user-provided input for theValue
field.When
ValueType
is set equal toCUSTOM
, theValue
field can't be empty.- Value
Security
Control Parameter Value - The current value of a control parameter.
- value
Type SecurityControl Parameter Configuration Value Type Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior.
When
ValueType
is set equal toDEFAULT
, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. WhenValueType
is set equal toDEFAULT
, Security Hub ignores user-provided input for theValue
field.When
ValueType
is set equal toCUSTOM
, theValue
field can't be empty.- value
Security
Control Parameter Value - The current value of a control parameter.
- value
Type SecurityControl Parameter Configuration Value Type Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior.
When
ValueType
is set equal toDEFAULT
, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. WhenValueType
is set equal toDEFAULT
, Security Hub ignores user-provided input for theValue
field.When
ValueType
is set equal toCUSTOM
, theValue
field can't be empty.- value
Security
Control Parameter Value - The current value of a control parameter.
- value_
type SecurityControl Parameter Configuration Value Type Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior.
When
ValueType
is set equal toDEFAULT
, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. WhenValueType
is set equal toDEFAULT
, Security Hub ignores user-provided input for theValue
field.When
ValueType
is set equal toCUSTOM
, theValue
field can't be empty.- value
Security
Control Parameter Value - The current value of a control parameter.
- value
Type "DEFAULT" | "CUSTOM" Identifies whether a control parameter uses a custom user-defined value or subscribes to the default AWS Security Hub behavior.
When
ValueType
is set equal toDEFAULT
, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. WhenValueType
is set equal toDEFAULT
, Security Hub ignores user-provided input for theValue
field.When
ValueType
is set equal toCUSTOM
, theValue
field can't be empty.- value Property Map
- The current value of a control parameter.
SecurityControlParameterConfigurationValueType, SecurityControlParameterConfigurationValueTypeArgs
- Default
- DEFAULT
- Custom
- CUSTOM
- Security
Control Parameter Configuration Value Type Default - DEFAULT
- Security
Control Parameter Configuration Value Type Custom - CUSTOM
- Default
- DEFAULT
- Custom
- CUSTOM
- Default
- DEFAULT
- Custom
- CUSTOM
- DEFAULT
- DEFAULT
- CUSTOM
- CUSTOM
- "DEFAULT"
- DEFAULT
- "CUSTOM"
- CUSTOM
SecurityControlParameterValue, SecurityControlParameterValueArgs
- Boolean bool
- A control parameter that is a boolean.
- Double double
- A control parameter that is a double.
- Enum string
- A control parameter that is a enum.
- Enum
List List<string> - A control parameter that is a list of enums.
- Integer int
- A control parameter that is a integer.
- Integer
List List<int> - A control parameter that is a list of integers.
- String string
- A control parameter that is a string.
- String
List List<string> - A control parameter that is a list of strings.
- Boolean bool
- A control parameter that is a boolean.
- Double float64
- A control parameter that is a double.
- Enum string
- A control parameter that is a enum.
- Enum
List []string - A control parameter that is a list of enums.
- Integer int
- A control parameter that is a integer.
- Integer
List []int - A control parameter that is a list of integers.
- String string
- A control parameter that is a string.
- String
List []string - A control parameter that is a list of strings.
- boolean_ Boolean
- A control parameter that is a boolean.
- double_ Double
- A control parameter that is a double.
- enum
List List<String> - A control parameter that is a list of enums.
- enum_ String
- A control parameter that is a enum.
- integer Integer
- A control parameter that is a integer.
- integer
List List<Integer> - A control parameter that is a list of integers.
- string String
- A control parameter that is a string.
- string
List List<String> - A control parameter that is a list of strings.
- boolean boolean
- A control parameter that is a boolean.
- double number
- A control parameter that is a double.
- enum string
- A control parameter that is a enum.
- enum
List string[] - A control parameter that is a list of enums.
- integer number
- A control parameter that is a integer.
- integer
List number[] - A control parameter that is a list of integers.
- string string
- A control parameter that is a string.
- string
List string[] - A control parameter that is a list of strings.
- boolean bool
- A control parameter that is a boolean.
- double float
- A control parameter that is a double.
- enum str
- A control parameter that is a enum.
- enum_
list Sequence[str] - A control parameter that is a list of enums.
- integer int
- A control parameter that is a integer.
- integer_
list Sequence[int] - A control parameter that is a list of integers.
- string str
- A control parameter that is a string.
- string_
list Sequence[str] - A control parameter that is a list of strings.
- boolean Boolean
- A control parameter that is a boolean.
- double Number
- A control parameter that is a double.
- enum String
- A control parameter that is a enum.
- enum
List List<String> - A control parameter that is a list of enums.
- integer Number
- A control parameter that is a integer.
- integer
List List<Number> - A control parameter that is a list of integers.
- string String
- A control parameter that is a string.
- string
List List<String> - A control parameter that is a list of strings.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.