[ aws . securityhub ]
batch-import-findings¶
Description¶
Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.
The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.
After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.
NoteUserDefinedFieldsVerificationStateWorkflow
BatchImportFindingscan be used to update the following finding fields and objects only if they have not been updated usingBatchUpdateFindings. After they are updated usingBatchUpdateFindings, these fields cannot be updated usingBatchImportFindings.
ConfidenceCriticalityRelatedFindingsSeverityTypes
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
batch-import-findings
--findings <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--findings (list)
A list of findings to import. To successfully import a finding, it must follow the AWS Security Finding Format . Maximum of 100 findings per request.
(structure)
Provides consistent format for the contents of the Security Hub-aggregated findings.
AwsSecurityFindingformat enables you to share findings between AWS security services and third-party solutions, and security standards checks.Note
A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and standards checks.
SchemaVersion -> (string)
The schema version that a finding is formatted for.
Id -> (string)
The security findings provider-specific identifier for a finding.
ProductArn -> (string)
The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.
GeneratorId -> (string)
The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers’ solutions, this generator can be called a rule, a check, a detector, a plugin, etc.
AwsAccountId -> (string)
The AWS account ID that a finding is generated in.
Types -> (list)
One or more finding types in the format of
namespace/category/classifierthat classify a finding.Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
(string)
FirstObservedAt -> (string)
Indicates when the security-findings provider first observed the potential security issue that a finding captured.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.LastObservedAt -> (string)
Indicates when the security-findings provider most recently observed the potential security issue that a finding captured.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.CreatedAt -> (string)
Indicates when the security-findings provider created the potential security issue that a finding captured.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.UpdatedAt -> (string)
Indicates when the security-findings provider last updated the finding record.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Severity -> (structure)
A finding’s severity.
Product -> (double)
Deprecated. This attribute is being deprecated. Instead of providing
Product, provideOriginal.The native severity as defined by the AWS service or integrated partner product that generated the finding.
Label -> (string)
The severity value of the finding. The allowed values are the following.
INFORMATIONAL- No issue was found.
LOW- The issue does not require action on its own.
MEDIUM- The issue must be addressed but not urgently.
HIGH- The issue must be addressed as a priority.
CRITICAL- The issue must be remediated immediately to avoid it escalating.If you provide
Normalizedand do not provideLabel, thenLabelis set automatically as follows.
0 -
INFORMATIONAL1–39 -
LOW40–69 -
MEDIUM70–89 -
HIGH90–100 -
CRITICALNormalized -> (integer)
Deprecated. The normalized severity of a finding. This attribute is being deprecated. Instead of providing
Normalized, provideLabel.If you provide
Labeland do not provideNormalized, thenNormalizedis set automatically as follows.
INFORMATIONAL- 0
LOW- 1
MEDIUM- 40
HIGH- 70
CRITICAL- 90Original -> (string)
The native severity from the finding product that generated the finding.
Confidence -> (integer)
A finding’s confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.
Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
Criticality -> (integer)
The level of importance assigned to the resources associated with the finding.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
Title -> (string)
A finding’s title.
Note
In this release,
Titleis a required property.Description -> (string)
A finding’s description.
Note
In this release,
Descriptionis a required property.Remediation -> (structure)
A data type that describes the remediation options for a finding.
Recommendation -> (structure)
A recommendation on the steps to take to remediate the issue identified by a finding.
Text -> (string)
Describes the recommended steps to take to remediate an issue identified in a finding.
Url -> (string)
A URL to a page or site that contains information about how to remediate a finding.
SourceUrl -> (string)
A URL that links to a page about the current finding in the security-findings provider’s solution.
ProductFields -> (map)
A data type where security-findings providers can include additional solution-specific details that aren’t part of the defined
AwsSecurityFindingformat.key -> (string)
value -> (string)
UserDefinedFields -> (map)
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
key -> (string)
value -> (string)
Malware -> (list)
A list of malware related to a finding.
(structure)
A list of malware related to a finding.
Name -> (string)
The name of the malware that was observed.
Type -> (string)
The type of the malware that was observed.
Path -> (string)
The file system path of the malware that was observed.
State -> (string)
The state of the malware that was observed.
Network -> (structure)
The details of network-related information about a finding.
Direction -> (string)
The direction of network traffic associated with a finding.
Protocol -> (string)
The protocol of network-related information about a finding.
OpenPortRange -> (structure)
The range of open ports that is present on the network.
Begin -> (integer)
The first port in the port range.
End -> (integer)
The last port in the port range.
SourceIpV4 -> (string)
The source IPv4 address of network-related information about a finding.
SourceIpV6 -> (string)
The source IPv6 address of network-related information about a finding.
SourcePort -> (integer)
The source port of network-related information about a finding.
SourceDomain -> (string)
The source domain of network-related information about a finding.
SourceMac -> (string)
The source media access control (MAC) address of network-related information about a finding.
DestinationIpV4 -> (string)
The destination IPv4 address of network-related information about a finding.
DestinationIpV6 -> (string)
The destination IPv6 address of network-related information about a finding.
DestinationPort -> (integer)
The destination port of network-related information about a finding.
DestinationDomain -> (string)
The destination domain of network-related information about a finding.
NetworkPath -> (list)
Provides information about a network path that is relevant to a finding. Each entry under
NetworkPathrepresents a component of that path.(structure)
Information about a network path component.
ComponentId -> (string)
The identifier of a component in the network path.
ComponentType -> (string)
The type of component.
Egress -> (structure)
Information about the component that comes after the current component in the network path.
Protocol -> (string)
The protocol used for the component.
Destination -> (structure)
Information about the destination of the component.
Address -> (list)
The IP addresses of the destination.
(string)
PortRanges -> (list)
A list of port ranges for the destination.
(structure)
A range of ports.
Begin -> (integer)
The first port in the port range.
End -> (integer)
The last port in the port range.
Source -> (structure)
Information about the origin of the component.
Address -> (list)
The IP addresses of the destination.
(string)
PortRanges -> (list)
A list of port ranges for the destination.
(structure)
A range of ports.
Begin -> (integer)
The first port in the port range.
End -> (integer)
The last port in the port range.
Ingress -> (structure)
Information about the component that comes before the current node in the network path.
Protocol -> (string)
The protocol used for the component.
Destination -> (structure)
Information about the destination of the component.
Address -> (list)
The IP addresses of the destination.
(string)
PortRanges -> (list)
A list of port ranges for the destination.
(structure)
A range of ports.
Begin -> (integer)
The first port in the port range.
End -> (integer)
The last port in the port range.
Source -> (structure)
Information about the origin of the component.
Address -> (list)
The IP addresses of the destination.
(string)
PortRanges -> (list)
A list of port ranges for the destination.
(structure)
A range of ports.
Begin -> (integer)
The first port in the port range.
End -> (integer)
The last port in the port range.
Process -> (structure)
The details of process-related information about a finding.
Name -> (string)
The name of the process.
Path -> (string)
The path to the process executable.
Pid -> (integer)
The process ID.
ParentPid -> (integer)
The parent process ID.
LaunchedAt -> (string)
Indicates when the process was launched.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.TerminatedAt -> (string)
Indicates when the process was terminated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.ThreatIntelIndicators -> (list)
Threat intelligence details related to a finding.
(structure)
Details about the threat intelligence related to a finding.
Type -> (string)
The type of threat intelligence indicator.
Value -> (string)
The value of a threat intelligence indicator.
Category -> (string)
The category of a threat intelligence indicator.
LastObservedAt -> (string)
Indicates when the most recent instance of a threat intelligence indicator was observed.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Source -> (string)
The source of the threat intelligence indicator.
SourceUrl -> (string)
The URL to the page or site where you can get more information about the threat intelligence indicator.
Resources -> (list)
A set of resource data types that describe the resources that the finding refers to.
(structure)
A resource related to a finding.
Type -> (string)
The type of the resource that details are provided for. If possible, set
Typeto one of the supported resource types. For example, if the resource is an EC2 instance, then setTypetoAwsEc2Instance.If the resource does not match any of the provided types, then set
TypetoOther.Id -> (string)
The canonical identifier for the given resource type.
Partition -> (string)
The canonical AWS partition name that the Region is assigned to.
Region -> (string)
The canonical AWS external Region name where this resource is located.
ResourceRole -> (string)
Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,
Tags -> (map)
A list of AWS tags associated with a resource at the time the finding was processed.
key -> (string)
value -> (string)
Details -> (structure)
Additional details about the resource related to a finding.
AwsAutoScalingAutoScalingGroup -> (structure)
Details for an autoscaling group.
LaunchConfigurationName -> (string)
The name of the launch configuration.
LoadBalancerNames -> (list)
The list of load balancers associated with the group.
(string)
HealthCheckType -> (string)
The service to use for the health checks.
HealthCheckGracePeriod -> (integer)
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the health status of an EC2 instance that has come into service.
CreatedTime -> (string)
Indicates when the auto scaling group was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.AwsCodeBuildProject -> (structure)
Details for an AWS CodeBuild project.
EncryptionKey -> (string)
The AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the build output artifacts.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK alias (using the format alias/alias-name).
Environment -> (structure)
Information about the build environment for this build project.
Certificate -> (string)
The certificate to use with this build project.
ImagePullCredentialsType -> (string)
The type of credentials AWS CodeBuild uses to pull images in your build.
Valid values:
CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the AWS CodeBuild service principal.
SERVICE_ROLEspecifies that AWS CodeBuild uses your build project’s service role.When you use a cross-account or private registry image, you must use
SERVICE_ROLEcredentials. When you use an AWS CodeBuild curated image, you must useCODEBUILDcredentials.RegistryCredential -> (structure)
The credentials for access to a private registry.
Credential -> (string)
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.
Note
The credential can use the name of the credentials only if they exist in your current AWS Region.
CredentialProvider -> (string)
The service that created the credentials to access a private Docker registry.
The valid value,``SECRETS_MANAGER`` , is for AWS Secrets Manager.
Type -> (string)
The type of build environment to use for related builds.
The environment type
ARM_CONTAINERis available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).The environment type
LINUX_CONTAINERwith compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).The environment type
LINUX_GPU_CONTAINERis available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).Valid values:
WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINERName -> (string)
The name of the build project.
Source -> (structure)
Information about the build input source code for this build project.
Type -> (string)
The type of repository that contains the source code to be built. Valid values are:
BITBUCKET- The source code is in a Bitbucket repository.
CODECOMMIT- The source code is in an AWS CodeCommit repository.
CODEPIPELINE- The source code settings are specified in the source action of a pipeline in AWS CodePipeline.
GITHUB- The source code is in a GitHub repository.
GITHUB_ENTERPRISE- The source code is in a GitHub Enterprise repository.
NO_SOURCE- The project does not have input source code.
S3- The source code is in an S3 input bucket.Location -> (string)
Information about the location of the source code to be built.
Valid values include:
For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline’s source action instead of this value.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec file (for example,
https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name).For source code in an S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
bucket-name/path/to/object-name.zip).The path to the folder that contains the source code (for example,
bucket-name/path/to/source-code/folder/).For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec file.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec file.
GitCloneDepth -> (integer)
Information about the Git clone depth for the build project.
InsecureSsl -> (boolean)
Whether to ignore SSL warnings while connecting to the project source code.
ServiceRole -> (string)
The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
VpcConfig -> (structure)
Information about the VPC configuration that AWS CodeBuild accesses.
VpcId -> (string)
The ID of the VPC.
Subnets -> (list)
A list of one or more subnet IDs in your Amazon VPC.
(string)
SecurityGroupIds -> (list)
A list of one or more security group IDs in your Amazon VPC.
(string)
AwsCloudFrontDistribution -> (structure)
Details about a CloudFront distribution.
CacheBehaviors -> (structure)
Provides information about the cache configuration for the distribution.
Items -> (list)
The cache behaviors for the distribution.
(structure)
Information about a cache behavior for the distribution.
ViewerProtocolPolicy -> (string)
The protocol that viewers can use to access the files in an origin. You can specify the following options:
allow-all- Viewers can use HTTP or HTTPS.
redirect-to-https- CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit.
https-only- CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).DefaultCacheBehavior -> (structure)
The default cache behavior for the configuration.
ViewerProtocolPolicy -> (string)
The protocol that viewers can use to access the files in an origin. You can specify the following options:
allow-all- Viewers can use HTTP or HTTPS.
redirect-to-https- CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit.
https-only- CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).DefaultRootObject -> (string)
The object that CloudFront sends in response to requests from the origin (for example, index.html) when a viewer requests the root URL for the distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html).
DomainName -> (string)
The domain name corresponding to the distribution.
ETag -> (string)
The entity tag is a hash of the object.
LastModifiedTime -> (string)
Indicates when that the distribution was last modified.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Logging -> (structure)
A complex type that controls whether access logs are written for the distribution.
Bucket -> (string)
The Amazon S3 bucket to store the access logs in.
Enabled -> (boolean)
With this field, you can enable or disable the selected distribution.
IncludeCookies -> (boolean)
Specifies whether you want CloudFront to include cookies in access logs.
Prefix -> (string)
An optional string that you want CloudFront to use as a prefix to the access log filenames for this distribution.
Origins -> (structure)
A complex type that contains information about origins for this distribution.
Items -> (list)
A complex type that contains origins or origin groups for this distribution.
(structure)
A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), Amazon Elemental MediaStore, or other server from which CloudFront gets your files.
DomainName -> (string)
Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin.
Id -> (string)
A unique identifier for the origin or origin group.
OriginPath -> (string)
An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.
S3OriginConfig -> (structure)
An origin that is an S3 bucket that is not configured with static website hosting.
OriginAccessIdentity -> (string)
The CloudFront origin access identity to associate with the origin.
OriginGroups -> (structure)
Provides information about the origin groups in the distribution.
Items -> (list)
The list of origin groups.
(structure)
Information about an origin group for the distribution.
FailoverCriteria -> (structure)
Provides the criteria for an origin group to fail over.
StatusCodes -> (structure)
Information about the status codes that cause an origin group to fail over.
Items -> (list)
The list of status code values that can cause a failover to the next origin.
(integer)
Quantity -> (integer)
The number of status codes that can cause a failover.
Status -> (string)
Indicates the current status of the distribution.
WebAclId -> (string)
A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.
AwsEc2Instance -> (structure)
Details about an Amazon EC2 instance related to a finding.
Type -> (string)
The instance type of the instance.
ImageId -> (string)
The Amazon Machine Image (AMI) ID of the instance.
IpV4Addresses -> (list)
The IPv4 addresses associated with the instance.
(string)
IpV6Addresses -> (list)
The IPv6 addresses associated with the instance.
(string)
KeyName -> (string)
The key name associated with the instance.
IamInstanceProfileArn -> (string)
The IAM profile ARN of the instance.
VpcId -> (string)
The identifier of the VPC that the instance was launched in.
SubnetId -> (string)
The identifier of the subnet that the instance was launched in.
LaunchedAt -> (string)
Indicates when the instance was launched.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.AwsEc2NetworkInterface -> (structure)
Details for an Amazon EC2 network interface.
Attachment -> (structure)
The network interface attachment.
AttachTime -> (string)
Indicates when the attachment initiated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.AttachmentId -> (string)
The identifier of the network interface attachment
DeleteOnTermination -> (boolean)
Indicates whether the network interface is deleted when the instance is terminated.
DeviceIndex -> (integer)
The device index of the network interface attachment on the instance.
InstanceId -> (string)
The ID of the instance.
InstanceOwnerId -> (string)
The AWS account ID of the owner of the instance.
Status -> (string)
The attachment state.
Valid values:
attaching|attached|detaching|detachedNetworkInterfaceId -> (string)
The ID of the network interface.
SecurityGroups -> (list)
Security groups for the network interface.
(structure)
A security group associated with the network interface.
GroupName -> (string)
The name of the security group.
GroupId -> (string)
The ID of the security group.
SourceDestCheck -> (boolean)
Indicates whether traffic to or from the instance is validated.
IpV6Addresses -> (list)
The IPv6 addresses associated with the network interface.
(structure)
Provides information about an IPV6 address that is associated with the network interface.
IpV6Address -> (string)
The IPV6 address.
PrivateIpAddresses -> (list)
The private IPv4 addresses associated with the network interface.
(structure)
Provides information about a private IPv4 address that is with the network interface.
PrivateIpAddress -> (string)
The IP address.
PrivateDnsName -> (string)
The private DNS name for the IP address.
PublicDnsName -> (string)
The public DNS name of the network interface.
PublicIp -> (string)
The address of the Elastic IP address bound to the network interface.
AwsEc2SecurityGroup -> (structure)
Details for an EC2 security group.
GroupName -> (string)
The name of the security group.
GroupId -> (string)
The ID of the security group.
OwnerId -> (string)
The AWS account ID of the owner of the security group.
VpcId -> (string)
[VPC only] The ID of the VPC for the security group.
IpPermissions -> (list)
The inbound rules associated with the security group.
(structure)
An IP permission for an EC2 security group.
IpProtocol -> (string)
The IP protocol name (
tcp,udp,icmp,icmpv6) or number.[VPC only] Use
-1to specify all protocols.When authorizing security group rules, specifying -1 or a protocol number other than
tcp,udp,icmp, oricmpv6allows traffic on all ports, regardless of any port range you specify.For
tcp,udp, andicmp, you must specify a port range.For
icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.FromPort -> (integer)
The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ToPort -> (integer)
The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs -> (list)
The security group and AWS account ID pairs.
(structure)
A relationship between a security group and a user.
GroupId -> (string)
The ID of the security group.
GroupName -> (string)
The name of the security group.
PeeringStatus -> (string)
The status of a VPC peering connection, if applicable.
UserId -> (string)
The ID of an AWS account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS.
VpcId -> (string)
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId -> (string)
The ID of the VPC peering connection, if applicable.
IpRanges -> (list)
The IPv4 ranges.
(structure)
A range of IPv4 addresses.
CidrIp -> (string)
The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv4 address, use the /32 prefix length.
Ipv6Ranges -> (list)
The IPv6 ranges.
(structure)
A range of IPv6 addresses.
CidrIpv6 -> (string)
The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv6 address, use the /128 prefix length.
PrefixListIds -> (list)
[VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service to access through a VPC endpoint from instances associated with the security group.
(structure)
A prefix list ID.
PrefixListId -> (string)
The ID of the prefix.
IpPermissionsEgress -> (list)
[VPC only] The outbound rules associated with the security group.
(structure)
An IP permission for an EC2 security group.
IpProtocol -> (string)
The IP protocol name (
tcp,udp,icmp,icmpv6) or number.[VPC only] Use
-1to specify all protocols.When authorizing security group rules, specifying -1 or a protocol number other than
tcp,udp,icmp, oricmpv6allows traffic on all ports, regardless of any port range you specify.For
tcp,udp, andicmp, you must specify a port range.For
icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.FromPort -> (integer)
The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
ToPort -> (integer)
The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
UserIdGroupPairs -> (list)
The security group and AWS account ID pairs.
(structure)
A relationship between a security group and a user.
GroupId -> (string)
The ID of the security group.
GroupName -> (string)
The name of the security group.
PeeringStatus -> (string)
The status of a VPC peering connection, if applicable.
UserId -> (string)
The ID of an AWS account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS.
VpcId -> (string)
The ID of the VPC for the referenced security group, if applicable.
VpcPeeringConnectionId -> (string)
The ID of the VPC peering connection, if applicable.
IpRanges -> (list)
The IPv4 ranges.
(structure)
A range of IPv4 addresses.
CidrIp -> (string)
The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv4 address, use the /32 prefix length.
Ipv6Ranges -> (list)
The IPv6 ranges.
(structure)
A range of IPv6 addresses.
CidrIpv6 -> (string)
The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv6 address, use the /128 prefix length.
PrefixListIds -> (list)
[VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service to access through a VPC endpoint from instances associated with the security group.
(structure)
A prefix list ID.
PrefixListId -> (string)
The ID of the prefix.
AwsEc2Volume -> (structure)
Details for an EC2 volume.
CreateTime -> (string)
Indicates when the volume was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Encrypted -> (boolean)
Whether the volume is encrypted.
Size -> (integer)
The size of the volume, in GiBs.
SnapshotId -> (string)
The snapshot from which the volume was created.
Status -> (string)
The volume state.
KmsKeyId -> (string)
The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
Attachments -> (list)
The volume attachments.
(structure)
An attachment to an AWS EC2 volume.
AttachTime -> (string)
The datetime when the attachment initiated.
DeleteOnTermination -> (boolean)
Whether the EBS volume is deleted when the EC2 instance is terminated.
InstanceId -> (string)
The identifier of the EC2 instance.
Status -> (string)
The attachment state of the volume.
AwsEc2Vpc -> (structure)
Details for an EC2 VPC.
CidrBlockAssociationSet -> (list)
Information about the IPv4 CIDR blocks associated with the VPC.
(structure)
An IPv4 CIDR block association.
AssociationId -> (string)
The association ID for the IPv4 CIDR block.
CidrBlock -> (string)
The IPv4 CIDR block.
CidrBlockState -> (string)
Information about the state of the IPv4 CIDR block.
Ipv6CidrBlockAssociationSet -> (list)
Information about the IPv6 CIDR blocks associated with the VPC.
(structure)
An IPV6 CIDR block association.
AssociationId -> (string)
The association ID for the IPv6 CIDR block.
Ipv6CidrBlock -> (string)
The IPv6 CIDR block.
CidrBlockState -> (string)
Information about the state of the CIDR block.
DhcpOptionsId -> (string)
The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.
State -> (string)
The current state of the VPC.
AwsEc2Eip -> (structure)
Details about an Elastic IP address.
InstanceId -> (string)
The identifier of the EC2 instance.
PublicIp -> (string)
A public IP address that is associated with the EC2 instance.
AllocationId -> (string)
The identifier that AWS assigns to represent the allocation of the Elastic IP address for use with Amazon VPC.
AssociationId -> (string)
The identifier that represents the association of the Elastic IP address with an EC2 instance.
Domain -> (string)
The domain in which to allocate the address.
If the address is for use with EC2 instances in a VPC, then
Domainisvpc. Otherwise,Domainisstandard.PublicIpv4Pool -> (string)
The identifier of an IP address pool. This parameter allows Amazon EC2 to select an IP address from the address pool.
NetworkBorderGroup -> (string)
The name of the location from which the Elastic IP address is advertised.
NetworkInterfaceId -> (string)
The identifier of the network interface.
NetworkInterfaceOwnerId -> (string)
The AWS account ID of the owner of the network interface.
PrivateIpAddress -> (string)
The private IP address that is associated with the Elastic IP address.
AwsElbv2LoadBalancer -> (structure)
Details about a load balancer.
AvailabilityZones -> (list)
The Availability Zones for the load balancer.
(structure)
Information about an Availability Zone.
ZoneName -> (string)
The name of the Availability Zone.
SubnetId -> (string)
The ID of the subnet. You can specify one subnet per Availability Zone.
CanonicalHostedZoneId -> (string)
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
CreatedTime -> (string)
Indicates when the load balancer was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.DNSName -> (string)
The public DNS name of the load balancer.
IpAddressType -> (string)
The type of IP addresses used by the subnets for your load balancer. The possible values are
ipv4(for IPv4 addresses) anddualstack(for IPv4 and IPv6 addresses).Scheme -> (string)
The nodes of an Internet-facing load balancer have public IP addresses.
SecurityGroups -> (list)
The IDs of the security groups for the load balancer.
(string)
State -> (structure)
The state of the load balancer.
Code -> (string)
The state code. The initial state of the load balancer is provisioning.
After the load balancer is fully set up and ready to route traffic, its state is active.
If the load balancer could not be set up, its state is failed.
Reason -> (string)
A description of the state.
Type -> (string)
The type of load balancer.
VpcId -> (string)
The ID of the VPC for the load balancer.
AwsElasticsearchDomain -> (structure)
Details for an Elasticsearch domain.
AccessPolicies -> (string)
IAM policy document specifying the access policies for the new Amazon ES domain.
DomainEndpointOptions -> (structure)
Additional options for the domain endpoint.
EnforceHTTPS -> (boolean)
Whether to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy -> (string)
The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch domain.
Valid values:
Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher
Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2DomainId -> (string)
Unique identifier for an Amazon ES domain.
DomainName -> (string)
Name of an Amazon ES domain.
Domain names are unique across all domains owned by the same account within an AWS Region.
Domain names must start with a lowercase letter and must be between 3 and 28 characters.
Valid characters are a-z (lowercase only), 0-9, and – (hyphen).
Endpoint -> (string)
Domain-specific endpoint used to submit index, search, and data upload requests to an Amazon ES domain.
The endpoint is a service URL.
Endpoints -> (map)
The key-value pair that exists if the Amazon ES domain uses VPC endpoints.
key -> (string)
value -> (string)
ElasticsearchVersion -> (string)
Elasticsearch version.
EncryptionAtRestOptions -> (structure)
Details about the configuration for encryption at rest.
Enabled -> (boolean)
Whether encryption at rest is enabled.
KmsKeyId -> (string)
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
NodeToNodeEncryptionOptions -> (structure)
Details about the configuration for node-to-node encryption.
Enabled -> (boolean)
Whether node-to-node encryption is enabled.
VPCOptions -> (structure)
Information that Amazon ES derives based on
VPCOptionsfor the domain.AvailabilityZones -> (list)
The list of Availability Zones associated with the VPC subnets.
(string)
SecurityGroupIds -> (list)
The list of security group IDs associated with the VPC endpoints for the domain.
(string)
SubnetIds -> (list)
A list of subnet IDs associated with the VPC endpoints for the domain.
(string)
VPCId -> (string)
ID for the VPC.
AwsS3Bucket -> (structure)
Details about an Amazon S3 bucket related to a finding.
OwnerId -> (string)
The canonical user ID of the owner of the S3 bucket.
OwnerName -> (string)
The display name of the owner of the S3 bucket.
CreatedAt -> (string)
Indicates when the S3 bucket was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.ServerSideEncryptionConfiguration -> (structure)
The encryption rules that are applied to the S3 bucket.
Rules -> (list)
The encryption rules that are applied to the S3 bucket.
(structure)
An encryption rule to apply to the S3 bucket.
ApplyServerSideEncryptionByDefault -> (structure)
Specifies the default server-side encryption to apply to new objects in the bucket. If a
PUTobject request doesn’t specify any server-side encryption, this default encryption is applied.SSEAlgorithm -> (string)
Server-side encryption algorithm to use for the default encryption.
KMSMasterKeyID -> (string)
AWS KMS customer master key (CMK) ID to use for the default encryption.
AwsS3Object -> (structure)
Details about an Amazon S3 object related to a finding.
LastModified -> (string)
Indicates when the object was last modified.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.ETag -> (string)
The opaque identifier assigned by a web server to a specific version of a resource found at a URL.
VersionId -> (string)
The version of the object.
ContentType -> (string)
A standard MIME type describing the format of the object data.
ServerSideEncryption -> (string)
If the object is stored using server-side encryption, the value of the server-side encryption algorithm used when storing this object in Amazon S3.
SSEKMSKeyId -> (string)
The identifier of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.
AwsSecretsManagerSecret -> (structure)
Details about a Secrets Manager secret.
RotationRules -> (structure)
Defines the rotation schedule for the secret.
AutomaticallyAfterDays -> (integer)
The number of days after the previous rotation to rotate the secret.
RotationOccurredWithinFrequency -> (boolean)
Whether the rotation occurred within the specified rotation frequency.
KmsKeyId -> (string)
The ARN, Key ID, or alias of the AWS KMS customer master key (CMK) used to encrypt the
SecretStringorSecretBinaryvalues for versions of this secret.RotationEnabled -> (boolean)
Whether rotation is enabled.
RotationLambdaArn -> (string)
The ARN of the Lambda function that rotates the secret.
Deleted -> (boolean)
Whether the secret is deleted.
Name -> (string)
The name of the secret.
Description -> (string)
The user-provided description of the secret.
AwsIamAccessKey -> (structure)
Details about an IAM access key related to a finding.
UserName -> (string)
The user associated with the IAM access key related to a finding.
The
UserNameparameter has been replaced with thePrincipalNameparameter because access keys can also be assigned to principals that are not IAM users.Status -> (string)
The status of the IAM access key related to a finding.
CreatedAt -> (string)
Indicates when the IAM access key was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.PrincipalId -> (string)
The ID of the principal associated with an access key.
PrincipalType -> (string)
The type of principal associated with an access key.
PrincipalName -> (string)
The name of the principal.
AccountId -> (string)
The AWS account ID of the account for the key.
AccessKeyId -> (string)
The identifier of the access key.
SessionContext -> (structure)
Information about the session that the key was used for.
Attributes -> (structure)
Attributes of the session that the key was used for.
MfaAuthenticated -> (boolean)
Indicates whether the session used multi-factor authentication (MFA).
CreationDate -> (string)
Indicates when the session was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.SessionIssuer -> (structure)
Information about the entity that created the session.
Type -> (string)
The type of principal (user, role, or group) that created the session.
PrincipalId -> (string)
The principal ID of the principal (user, role, or group) that created the session.
Arn -> (string)
The ARN of the session.
AccountId -> (string)
The identifier of the AWS account that created the session.
UserName -> (string)
The name of the principal that created the session.
AwsIamUser -> (structure)
Details about an IAM user.
AttachedManagedPolicies -> (list)
A list of the managed policies that are attached to the user.
(structure)
A managed policy that is attached to an IAM principal.
PolicyName -> (string)
The name of the policy.
PolicyArn -> (string)
The ARN of the policy.
CreateDate -> (string)
Indicates when the user was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.GroupList -> (list)
A list of IAM groups that the user belongs to.
(string)
Path -> (string)
The path to the user.
PermissionsBoundary -> (structure)
The permissions boundary for the user.
PermissionsBoundaryArn -> (string)
The ARN of the policy used to set the permissions boundary.
PermissionsBoundaryType -> (string)
The usage type for the permissions boundary.
UserId -> (string)
The unique identifier for the user.
UserName -> (string)
The name of the user.
UserPolicyList -> (list)
The list of inline policies that are embedded in the user.
(structure)
Information about an inline policy that is embedded in the user.
PolicyName -> (string)
The name of the policy.
AwsIamPolicy -> (structure)
Details about an IAM permissions policy.
AttachmentCount -> (integer)
The number of users, groups, and roles that the policy is attached to.
CreateDate -> (string)
When the policy was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.DefaultVersionId -> (string)
The identifier of the default version of the policy.
Description -> (string)
A description of the policy.
IsAttachable -> (boolean)
Whether the policy can be attached to a user, group, or role.
Path -> (string)
The path to the policy.
PermissionsBoundaryUsageCount -> (integer)
The number of users and roles that use the policy to set the permissions boundary.
PolicyId -> (string)
The unique identifier of the policy.
PolicyName -> (string)
The name of the policy.
PolicyVersionList -> (list)
List of versions of the policy.
(structure)
A version of an IAM policy.
VersionId -> (string)
The identifier of the policy version.
IsDefaultVersion -> (boolean)
Whether the version is the default version.
CreateDate -> (string)
Indicates when the version was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.UpdateDate -> (string)
When the policy was most recently updated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.AwsApiGatewayV2Stage -> (structure)
Provides information about a version 2 stage for Amazon API Gateway.
CreatedDate -> (string)
Indicates when the stage was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Description -> (string)
The description of the stage.
DefaultRouteSettings -> (structure)
Default route settings for the stage.
DetailedMetricsEnabled -> (boolean)
Indicates whether detailed metrics are enabled.
LoggingLevel -> (string)
The logging level. The logging level affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.
If the logging level is
ERROR, then the logs only include error-level entries.If the logging level is
INFO, then the logs include bothERRORevents and extra informational events.Valid values:
OFF|ERROR|INFODataTraceEnabled -> (boolean)
Indicates whether data trace logging is enabled. Data trace logging affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.
ThrottlingBurstLimit -> (integer)
The throttling burst limit.
ThrottlingRateLimit -> (double)
The throttling rate limit.
DeploymentId -> (string)
The identifier of the deployment that the stage is associated with.
LastUpdatedDate -> (string)
Indicates when the stage was most recently updated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.RouteSettings -> (structure)
The route settings for the stage.
DetailedMetricsEnabled -> (boolean)
Indicates whether detailed metrics are enabled.
LoggingLevel -> (string)
The logging level. The logging level affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.
If the logging level is
ERROR, then the logs only include error-level entries.If the logging level is
INFO, then the logs include bothERRORevents and extra informational events.Valid values:
OFF|ERROR|INFODataTraceEnabled -> (boolean)
Indicates whether data trace logging is enabled. Data trace logging affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.
ThrottlingBurstLimit -> (integer)
The throttling burst limit.
ThrottlingRateLimit -> (double)
The throttling rate limit.
StageName -> (string)
The name of the stage.
StageVariables -> (map)
A map that defines the stage variables for the stage.
Variable names can have alphanumeric and underscore characters.
Variable values can contain the following characters:
Uppercase and lowercase letters
Numbers
Special characters -._~:/?#&=,
key -> (string)
value -> (string)
AccessLogSettings -> (structure)
Information about settings for logging access for the stage.
Format -> (string)
A single-line format of the access logs of data, as specified by selected
$contextvariables. The format must include at least$context.requestId.DestinationArn -> (string)
The ARN of the CloudWatch Logs log group that receives the access logs.
AutoDeploy -> (boolean)
Indicates whether updates to an API automatically trigger a new deployment.
LastDeploymentStatusMessage -> (string)
The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
ApiGatewayManaged -> (boolean)
Indicates whether the stage is managed by API Gateway.
AwsApiGatewayV2Api -> (structure)
Provides information about a version 2 API in Amazon API Gateway.
ApiEndpoint -> (string)
The URI of the API.
Uses the format `` <api-id> .execute-api.*<region>* .amazonaws.com``
The stage name is typically appended to the URI to form a complete path to a deployed API stage.
ApiId -> (string)
The identifier of the API.
ApiKeySelectionExpression -> (string)
An API key selection expression. Supported only for WebSocket APIs.
CreatedDate -> (string)
Indicates when the API was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Description -> (string)
A description of the API.
Version -> (string)
The version identifier for the API.
Name -> (string)
The name of the API.
ProtocolType -> (string)
The API protocol for the API.
Valid values:
WEBSOCKET|HTTPRouteSelectionExpression -> (string)
The route selection expression for the API.
For HTTP APIs, must be
${request.method} ${request.path}. This is the default value for HTTP APIs.For WebSocket APIs, there is no default value.
CorsConfiguration -> (structure)
A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
AllowOrigins -> (list)
The allowed origins for CORS requests.
(string)
AllowCredentials -> (boolean)
Indicates whether the CORS request includes credentials.
ExposeHeaders -> (list)
The exposed headers for CORS requests.
(string)
MaxAge -> (integer)
The number of seconds for which the browser caches preflight request results.
AllowMethods -> (list)
The allowed methods for CORS requests.
(string)
AllowHeaders -> (list)
The allowed headers for CORS requests.
(string)
AwsDynamoDbTable -> (structure)
Details about a DynamoDB table.
AttributeDefinitions -> (list)
A list of attribute definitions for the table.
(structure)
Contains a definition of an attribute for the table.
AttributeName -> (string)
The name of the attribute.
AttributeType -> (string)
The type of the attribute.
BillingModeSummary -> (structure)
Information about the billing for read/write capacity on the table.
BillingMode -> (string)
The method used to charge for read and write throughput and to manage capacity.
LastUpdateToPayPerRequestDateTime -> (string)
If the billing mode is
PAY_PER_REQUEST, indicates when the billing mode was set to that value.Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.CreationDateTime -> (string)
Indicates when the table was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.GlobalSecondaryIndexes -> (list)
List of global secondary indexes for the table.
(structure)
Information abut a global secondary index for the table.
Backfilling -> (boolean)
Whether the index is currently backfilling.
IndexArn -> (string)
The ARN of the index.
IndexName -> (string)
The name of the index.
IndexSizeBytes -> (long)
The total size in bytes of the index.
IndexStatus -> (string)
The current status of the index.
ItemCount -> (integer)
The number of items in the index.
KeySchema -> (list)
The key schema for the index.
(structure)
A component of the key schema for the DynamoDB table, a global secondary index, or a local secondary index.
AttributeName -> (string)
The name of the key schema attribute.
KeyType -> (string)
The type of key used for the key schema attribute.
Projection -> (structure)
Attributes that are copied from the table into an index.
NonKeyAttributes -> (list)
The nonkey attributes that are projected into the index. For each attribute, provide the attribute name.
(string)
ProjectionType -> (string)
The types of attributes that are projected into the index.
ProvisionedThroughput -> (structure)
Information about the provisioned throughput settings for the indexes.
LastDecreaseDateTime -> (string)
Indicates when the provisioned throughput was last decreased.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.LastIncreaseDateTime -> (string)
Indicates when the provisioned throughput was last increased.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.NumberOfDecreasesToday -> (integer)
The number of times during the current UTC calendar day that the provisioned throughput was decreased.
ReadCapacityUnits -> (integer)
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException.WriteCapacityUnits -> (integer)
The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException.GlobalTableVersion -> (string)
The version of global tables being used.
ItemCount -> (integer)
The number of items in the table.
KeySchema -> (list)
The primary key structure for the table.
(structure)
A component of the key schema for the DynamoDB table, a global secondary index, or a local secondary index.
AttributeName -> (string)
The name of the key schema attribute.
KeyType -> (string)
The type of key used for the key schema attribute.
LatestStreamArn -> (string)
The ARN of the latest stream for the table.
LatestStreamLabel -> (string)
The label of the latest stream. The label is not a unique identifier.
LocalSecondaryIndexes -> (list)
The list of local secondary indexes for the table.
(structure)
Information about a local secondary index for a DynamoDB table.
IndexArn -> (string)
The ARN of the index.
IndexName -> (string)
The name of the index.
KeySchema -> (list)
The complete key schema for the index.
(structure)
A component of the key schema for the DynamoDB table, a global secondary index, or a local secondary index.
AttributeName -> (string)
The name of the key schema attribute.
KeyType -> (string)
The type of key used for the key schema attribute.
Projection -> (structure)
Attributes that are copied from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
NonKeyAttributes -> (list)
The nonkey attributes that are projected into the index. For each attribute, provide the attribute name.
(string)
ProjectionType -> (string)
The types of attributes that are projected into the index.
ProvisionedThroughput -> (structure)
Information about the provisioned throughput for the table.
LastDecreaseDateTime -> (string)
Indicates when the provisioned throughput was last decreased.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.LastIncreaseDateTime -> (string)
Indicates when the provisioned throughput was last increased.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.NumberOfDecreasesToday -> (integer)
The number of times during the current UTC calendar day that the provisioned throughput was decreased.
ReadCapacityUnits -> (integer)
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException.WriteCapacityUnits -> (integer)
The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException.Replicas -> (list)
The list of replicas of this table.
(structure)
Information about a replica of a DynamoDB table.
GlobalSecondaryIndexes -> (list)
List of global secondary indexes for the replica.
(structure)
Information about a global secondary index for a DynamoDB table replica.
IndexName -> (string)
The name of the index.
ProvisionedThroughputOverride -> (structure)
Replica-specific configuration for the provisioned throughput for the index.
ReadCapacityUnits -> (integer)
The read capacity units for the replica.
KmsMasterKeyId -> (string)
The identifier of the AWS KMS customer master key (CMK) that will be used for AWS KMS encryption for the replica.
ProvisionedThroughputOverride -> (structure)
Replica-specific configuration for the provisioned throughput.
ReadCapacityUnits -> (integer)
The read capacity units for the replica.
RegionName -> (string)
The name of the Region where the replica is located.
ReplicaStatus -> (string)
The current status of the replica.
ReplicaStatusDescription -> (string)
Detailed information about the replica status.
RestoreSummary -> (structure)
Information about the restore for the table.
SourceBackupArn -> (string)
The ARN of the source backup from which the table was restored.
SourceTableArn -> (string)
The ARN of the source table for the backup.
RestoreDateTime -> (string)
Indicates the point in time that the table was restored to.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.RestoreInProgress -> (boolean)
Whether a restore is currently in progress.
SseDescription -> (structure)
Information about the server-side encryption for the table.
InaccessibleEncryptionDateTime -> (string)
If the key is inaccessible, the date and time when DynamoDB detected that the key was inaccessible.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Status -> (string)
The status of the server-side encryption.
SseType -> (string)
The type of server-side encryption.
KmsMasterKeyArn -> (string)
The ARN of the AWS KMS customer master key (CMK) that is used for the AWS KMS encryption.
StreamSpecification -> (structure)
The current DynamoDB Streams configuration for the table.
StreamEnabled -> (boolean)
Indicates whether DynamoDB Streams is enabled on the table.
StreamViewType -> (string)
Determines the information that is written to the table.
TableId -> (string)
The identifier of the table.
TableName -> (string)
The name of the table.
TableSizeBytes -> (long)
The total size of the table in bytes.
TableStatus -> (string)
The current status of the table.
AwsApiGatewayStage -> (structure)
Provides information about a version 1 Amazon API Gateway stage.
DeploymentId -> (string)
The identifier of the deployment that the stage points to.
ClientCertificateId -> (string)
The identifier of the client certificate for the stage.
StageName -> (string)
The name of the stage.
Description -> (string)
A description of the stage.
CacheClusterEnabled -> (boolean)
Indicates whether a cache cluster is enabled for the stage.
CacheClusterSize -> (string)
If a cache cluster is enabled, the size of the cache cluster.
CacheClusterStatus -> (string)
If a cache cluster is enabled, the status of the cache cluster.
MethodSettings -> (list)
Defines the method settings for the stage.
(structure)
Defines settings for a method for the stage.
MetricsEnabled -> (boolean)
Indicates whether CloudWatch metrics are enabled for the method.
LoggingLevel -> (string)
The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs.
If the logging level is
ERROR, then the logs only include error-level entries.If the logging level is
INFO, then the logs include bothERRORevents and extra informational events.Valid values:
OFF|ERROR|INFODataTraceEnabled -> (boolean)
Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.
ThrottlingBurstLimit -> (integer)
The throttling burst limit for the method.
ThrottlingRateLimit -> (double)
The throttling rate limit for the method.
CachingEnabled -> (boolean)
Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.
CacheTtlInSeconds -> (integer)
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.
CacheDataEncrypted -> (boolean)
Indicates whether the cached responses are encrypted.
RequireAuthorizationForCacheControl -> (boolean)
Indicates whether authorization is required for a cache invalidation request.
UnauthorizedCacheControlHeaderStrategy -> (string)
Indicates how to handle unauthorized requests for cache invalidation.
Valid values:
FAIL_WITH_403|SUCCEED_WITH_RESPONSE_HEADER|SUCCEED_WITHOUT_RESPONSE_HEADERHttpMethod -> (string)
The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
ResourcePath -> (string)
The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash.
For example, the path value
/resource/subresourcemust be encoded as/~1resource~1subresource.To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
Variables -> (map)
A map that defines the stage variables for the stage.
Variable names can have alphanumeric and underscore characters.
Variable values can contain the following characters:
Uppercase and lowercase letters
Numbers
Special characters -._~:/?#&=,
key -> (string)
value -> (string)
DocumentationVersion -> (string)
The version of the API documentation that is associated with the stage.
AccessLogSettings -> (structure)
Settings for logging access for the stage.
Format -> (string)
A single-line format of the access logs of data, as specified by selected
$contextvariables. The format must include at least$context.requestId.DestinationArn -> (string)
The ARN of the CloudWatch Logs log group that receives the access logs.
CanarySettings -> (structure)
Information about settings for canary deployment in the stage.
PercentTraffic -> (double)
The percentage of traffic that is diverted to a canary deployment.
DeploymentId -> (string)
The deployment identifier for the canary deployment.
StageVariableOverrides -> (map)
Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.
Each variable is represented as a string-to-string map between the stage variable name and the variable value.
key -> (string)
value -> (string)
UseStageCache -> (boolean)
Indicates whether the canary deployment uses the stage cache.
TracingEnabled -> (boolean)
Indicates whether active tracing with AWS X-Ray is enabled for the stage.
CreatedDate -> (string)
Indicates when the stage was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.LastUpdatedDate -> (string)
Indicates when the stage was most recently updated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.WebAclArn -> (string)
The ARN of the web ACL associated with the stage.
AwsApiGatewayRestApi -> (structure)
Provides information about a REST API in version 1 of Amazon API Gateway.
Id -> (string)
The identifier of the REST API.
Name -> (string)
The name of the REST API.
Description -> (string)
A description of the REST API.
CreatedDate -> (string)
Indicates when the API was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Version -> (string)
The version identifier for the REST API.
BinaryMediaTypes -> (list)
The list of binary media types supported by the REST API.
(string)
MinimumCompressionSize -> (integer)
The minimum size in bytes of a payload before compression is enabled.
If
null, then compression is disabled.If 0, then all payloads are compressed.
ApiKeySource -> (string)
The source of the API key for metering requests according to a usage plan.
HEADERindicates whether to read the API key from the X-API-Key header of a request.
AUTHORIZERindicates whether to read the API key from theUsageIdentifierKeyfrom a custom authorizer.EndpointConfiguration -> (structure)
The endpoint configuration of the REST API.
Types -> (list)
A list of endpoint types for the REST API.
For an edge-optimized API, the endpoint type is
EDGE. For a Regional API, the endpoint type isREGIONAL. For a private API, the endpoint type isPRIVATE.(string)
AwsCloudTrailTrail -> (structure)
Provides details about a CloudTrail trail.
CloudWatchLogsLogGroupArn -> (string)
The ARN of the log group that CloudTrail logs are delivered to.
CloudWatchLogsRoleArn -> (string)
The ARN of the role that the CloudWatch Logs endpoint assumes when it writes to the log group.
HasCustomEventSelectors -> (boolean)
Indicates whether the trail has custom event selectors.
HomeRegion -> (string)
The Region where the trail was created.
IncludeGlobalServiceEvents -> (boolean)
Indicates whether the trail publishes events from global services such as IAM to the log files.
IsMultiRegionTrail -> (boolean)
Indicates whether the trail applies only to the current Region or to all Regions.
IsOrganizationTrail -> (boolean)
Whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account.
KmsKeyId -> (string)
The AWS KMS key ID to use to encrypt the logs.
LogFileValidationEnabled -> (boolean)
Indicates whether CloudTrail log file validation is enabled.
Name -> (string)
The name of the trail.
S3BucketName -> (string)
The name of the S3 bucket where the log files are published.
S3KeyPrefix -> (string)
The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log files are published.
SnsTopicArn -> (string)
The ARN of the SNS topic that is used for notifications of log file delivery.
SnsTopicName -> (string)
The name of the SNS topic that is used for notifications of log file delivery.
TrailArn -> (string)
The ARN of the trail.
AwsSsmPatchCompliance -> (structure)
Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.
Patch -> (structure)
Information about the status of a patch.
ComplianceSummary -> (structure)
The compliance status details for the patch.
Status -> (string)
The current patch compliance status.
The possible status values are:
COMPLIANT
NON_COMPLIANT
UNSPECIFIED_DATACompliantCriticalCount -> (integer)
For the patches that are compliant, the number that have a severity of
CRITICAL.CompliantHighCount -> (integer)
For the patches that are compliant, the number that have a severity of
HIGH.CompliantMediumCount -> (integer)
For the patches that are compliant, the number that have a severity of
MEDIUM.ExecutionType -> (string)
The type of execution that was used determine compliance.
NonCompliantCriticalCount -> (integer)
For the patch items that are noncompliant, the number of items that have a severity of
CRITICAL.CompliantInformationalCount -> (integer)
For the patches that are compliant, the number that have a severity of
INFORMATIONAL.NonCompliantInformationalCount -> (integer)
For the patches that are noncompliant, the number that have a severity of
INFORMATIONAL.CompliantUnspecifiedCount -> (integer)
For the patches that are compliant, the number that have a severity of
UNSPECIFIED.NonCompliantLowCount -> (integer)
For the patches that are noncompliant, the number that have a severity of
LOW.NonCompliantHighCount -> (integer)
For the patches that are noncompliant, the number that have a severity of
HIGH.CompliantLowCount -> (integer)
For the patches that are compliant, the number that have a severity of
LOW.ComplianceType -> (string)
The type of resource for which the compliance was determined. For
AwsSsmPatchCompliance,ComplianceTypeisPatch.PatchBaselineId -> (string)
The identifier of the patch baseline. The patch baseline lists the patches that are approved for installation.
OverallSeverity -> (string)
The highest severity for the patches.
NonCompliantMediumCount -> (integer)
For the patches that are noncompliant, the number that have a severity of
MEDIUM.NonCompliantUnspecifiedCount -> (integer)
For the patches that are noncompliant, the number that have a severity of
UNSPECIFIED.PatchGroup -> (string)
The identifier of the patch group for which compliance was determined. A patch group uses tags to group EC2 instances that should have the same patch compliance.
AwsCertificateManagerCertificate -> (structure)
Provides details about an AWS Certificate Manager (ACM) certificate.
CertificateAuthorityArn -> (string)
The ARN of the private certificate authority (CA) that will be used to issue the certificate.
CreatedAt -> (string)
Indicates when the certificate was requested.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.DomainName -> (string)
The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.
DomainValidationOptions -> (list)
Contains information about the initial validation of each domain name that occurs as a result of the
RequestCertificaterequest.Only provided if the certificate type is
AMAZON_ISSUED.(structure)
Contains information about one of the following:
The initial validation of each domain name that occurs as a result of the
RequestCertificaterequestThe validation of each domain name in the certificate, as it pertains to AWS Certificate Manager managed renewal
DomainName -> (string)
A fully qualified domain name (FQDN) in the certificate.
ResourceRecord -> (structure)
The CNAME record that is added to the DNS database for domain validation.
Name -> (string)
The name of the resource.
Type -> (string)
The type of resource.
Value -> (string)
The value of the resource.
ValidationDomain -> (string)
The domain name that AWS Certificate Manager uses to send domain validation emails.
ValidationEmails -> (list)
A list of email addresses that AWS Certificate Manager uses to send domain validation emails.
(string)
ValidationMethod -> (string)
The method used to validate the domain name.
ValidationStatus -> (string)
The validation status of the domain name.
ExtendedKeyUsages -> (list)
Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
(structure)
Contains information about an extended key usage X.509 v3 extension object.
Name -> (string)
The name of an extension value. Indicates the purpose for which the certificate public key can be used.
OId -> (string)
An object identifier (OID) for the extension value.
The format is numbers separated by periods.
FailureReason -> (string)
For a failed certificate request, the reason for the failure.
Valid values:
NO_AVAILABLE_CONTACTS|ADDITIONAL_VERIFICATION_REQUIRED|DOMAIN_NOT_ALLOWED|INVALID_PUBLIC_DOMAIN|DOMAIN_VALIDATION_DENIED|CAA_ERROR|PCA_LIMIT_EXCEEDED|PCA_INVALID_ARN|PCA_INVALID_STATE|PCA_REQUEST_FAILED|PCA_NAME_CONSTRAINTS_VALIDATION|PCA_RESOURCE_NOT_FOUND|PCA_INVALID_ARGS|PCA_INVALID_DURATION|PCA_ACCESS_DENIED|SLR_NOT_FOUND|OTHERImportedAt -> (string)
Indicates when the certificate was imported. Provided if the certificate type is
IMPORTED.Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.InUseBy -> (list)
The list of ARNs for the AWS resources that use the certificate.
(string)
IssuedAt -> (string)
Indicates when the certificate was issued. Provided if the certificate type is
AMAZON_ISSUED.Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Issuer -> (string)
The name of the certificate authority that issued and signed the certificate.
KeyAlgorithm -> (string)
The algorithm that was used to generate the public-private key pair.
Valid values:
RSA_2048|RSA_1024|RSA_4096|EC_prime256v1|EC_secp384r1|EC_secp521r1KeyUsages -> (list)
A list of key usage X.509 v3 extension objects.
(structure)
Contains information about a key usage X.509 v3 extension object.
Name -> (string)
The key usage extension name.
NotAfter -> (string)
The time after which the certificate becomes invalid.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.NotBefore -> (string)
The time before which the certificate is not valid.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Options -> (structure)
Provides a value that specifies whether to add the certificate to a transparency log.
CertificateTransparencyLoggingPreference -> (string)
Whether to add the certificate to a transparency log.
Valid values:
DISABLED|ENABLEDRenewalEligibility -> (string)
Whether the certificate is eligible for renewal.
Valid values:
ELIGIBLE|INELIGIBLERenewalSummary -> (structure)
Information about the status of the AWS Certificate Manager managed renewal for the certificate. Provided only when the certificate type is
AMAZON_ISSUED.DomainValidationOptions -> (list)
Information about the validation of each domain name in the certificate, as it pertains to AWS Certificate Manager managed renewal. Provided only when the certificate type is
AMAZON_ISSUED.(structure)
Contains information about one of the following:
The initial validation of each domain name that occurs as a result of the
RequestCertificaterequestThe validation of each domain name in the certificate, as it pertains to AWS Certificate Manager managed renewal
DomainName -> (string)
A fully qualified domain name (FQDN) in the certificate.
ResourceRecord -> (structure)
The CNAME record that is added to the DNS database for domain validation.
Name -> (string)
The name of the resource.
Type -> (string)
The type of resource.
Value -> (string)
The value of the resource.
ValidationDomain -> (string)
The domain name that AWS Certificate Manager uses to send domain validation emails.
ValidationEmails -> (list)
A list of email addresses that AWS Certificate Manager uses to send domain validation emails.
(string)
ValidationMethod -> (string)
The method used to validate the domain name.
ValidationStatus -> (string)
The validation status of the domain name.
RenewalStatus -> (string)
The status of the AWS Certificate Manager managed renewal of the certificate.
Valid values:
PENDING_AUTO_RENEWAL|PENDING_VALIDATION|SUCCESS|FAILEDRenewalStatusReason -> (string)
The reason that a renewal request was unsuccessful.
Valid values:
NO_AVAILABLE_CONTACTS|ADDITIONAL_VERIFICATION_REQUIRED|DOMAIN_NOT_ALLOWED|INVALID_PUBLIC_DOMAIN|DOMAIN_VALIDATION_DENIED|CAA_ERROR|PCA_LIMIT_EXCEEDED|PCA_INVALID_ARN|PCA_INVALID_STATE|PCA_REQUEST_FAILED|PCA_NAME_CONSTRAINTS_VALIDATION|PCA_RESOURCE_NOT_FOUND|PCA_INVALID_ARGS|PCA_INVALID_DURATION|PCA_ACCESS_DENIED|SLR_NOT_FOUND|OTHERUpdatedAt -> (string)
Indicates when the renewal summary was last updated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Serial -> (string)
The serial number of the certificate.
SignatureAlgorithm -> (string)
The algorithm that was used to sign the certificate.
Status -> (string)
The status of the certificate.
Valid values:
PENDING_VALIDATION|ISSUED|INACTIVE|EXPIRED|VALIDATION_TIMED_OUT|REVOKED|FAILEDSubject -> (string)
The name of the entity that is associated with the public key contained in the certificate.
SubjectAlternativeNames -> (list)
One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate.
The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
(string)
Type -> (string)
The source of the certificate. For certificates that AWS Certificate Manager provides,
TypeisAMAZON_ISSUED. For certificates that are imported withImportCertificate,TypeisIMPORTED.Valid values:
IMPORTED|AMAZON_ISSUED|PRIVATEAwsRedshiftCluster -> (structure)
Contains details about an Amazon Redshift cluster.
AllowVersionUpgrade -> (boolean)
Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.
AutomatedSnapshotRetentionPeriod -> (integer)
The number of days that automatic cluster snapshots are retained.
AvailabilityZone -> (string)
The name of the Availability Zone in which the cluster is located.
ClusterAvailabilityStatus -> (string)
The availability status of the cluster for queries. Possible values are the following:
Available- The cluster is available for queries.
Unavailable- The cluster is not available for queries.
Maintenance- The cluster is intermittently available for queries due to maintenance activities.
Modifying-The cluster is intermittently available for queries due to changes that modify the cluster.
Failed- The cluster failed and is not available for queries.ClusterCreateTime -> (string)
Indicates when the cluster was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.ClusterIdentifier -> (string)
The unique identifier of the cluster.
ClusterNodes -> (list)
The nodes in the cluster.
(structure)
A node in an Amazon Redshift cluster.
NodeRole -> (string)
The role of the node. A node might be a leader node or a compute node.
PrivateIpAddress -> (string)
The private IP address of the node.
PublicIpAddress -> (string)
The public IP address of the node.
ClusterParameterGroups -> (list)
The list of cluster parameter groups that are associated with this cluster.
(structure)
A cluster parameter group that is associated with an Amazon Redshift cluster.
ClusterParameterStatusList -> (list)
The list of parameter statuses.
(structure)
The status of a parameter in a cluster parameter group for an Amazon Redshift cluster.
ParameterName -> (string)
The name of the parameter.
ParameterApplyStatus -> (string)
The status of the parameter. Indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when it was applied.
Valid values:
in-sync|pending-reboot|applying|invalid-parameter|apply-deferred|apply-error|unknown-errorParameterApplyErrorDescription -> (string)
The error that prevented the parameter from being applied to the database.
ParameterApplyStatus -> (string)
The status of updates to the parameters.
ParameterGroupName -> (string)
The name of the parameter group.
ClusterPublicKey -> (string)
The public key for the cluster.
ClusterRevisionNumber -> (string)
The specific revision number of the database in the cluster.
ClusterSecurityGroups -> (list)
A list of cluster security groups that are associated with the cluster.
(structure)
A security group that is associated with the cluster.
ClusterSecurityGroupName -> (string)
The name of the cluster security group.
Status -> (string)
The status of the cluster security group.
ClusterSnapshotCopyStatus -> (structure)
Information about the destination Region and retention period for the cross-Region snapshot copy.
DestinationRegion -> (string)
The destination Region that snapshots are automatically copied to when cross-Region snapshot copy is enabled.
ManualSnapshotRetentionPeriod -> (integer)
The number of days that manual snapshots are retained in the destination region after they are copied from a source region.
If the value is -1, then the manual snapshot is retained indefinitely.
Valid values: Either -1 or an integer between 1 and 3,653
RetentionPeriod -> (integer)
The number of days to retain automated snapshots in the destination Region after they are copied from a source Region.
SnapshotCopyGrantName -> (string)
The name of the snapshot copy grant.
ClusterStatus -> (string)
The current status of the cluster.
Valid values:
available|available, prep-for-resize|available, resize-cleanup|cancelling-resize|creating|deleting|final-snapshot|hardware-failure|incompatible-hsm|incompatible-network|incompatible-parameters|incompatible-restore|modifying|paused|rebooting|renaming|resizing|rotating-keys|storage-full|updating-hsmClusterSubnetGroupName -> (string)
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
ClusterVersion -> (string)
The version ID of the Amazon Redshift engine that runs on the cluster.
DBName -> (string)
The name of the initial database that was created when the cluster was created.
The same name is returned for the life of the cluster.
If an initial database is not specified, a database named
devdevis created by default.DeferredMaintenanceWindows -> (list)
List of time windows during which maintenance was deferred.
(structure)
A time windows during which maintenance was deferred for an Amazon Redshift cluster.
DeferMaintenanceEndTime -> (string)
The end of the time window for which maintenance was deferred.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.DeferMaintenanceIdentifier -> (string)
The identifier of the maintenance window.
DeferMaintenanceStartTime -> (string)
The start of the time window for which maintenance was deferred.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.ElasticIpStatus -> (structure)
Information about the status of the Elastic IP (EIP) address.
ElasticIp -> (string)
The elastic IP address for the cluster.
Status -> (string)
The status of the elastic IP address.
ElasticResizeNumberOfNodeOptions -> (string)
The number of nodes that you can use the elastic resize method to resize the cluster to.
Encrypted -> (boolean)
Indicates whether the data in the cluster is encrypted at rest.
Endpoint -> (structure)
The connection endpoint.
Address -> (string)
The DNS address of the cluster.
Port -> (integer)
The port that the database engine listens on.
EnhancedVpcRouting -> (boolean)
Indicates whether to create the cluster with enhanced VPC routing enabled.
ExpectedNextSnapshotScheduleTime -> (string)
Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.ExpectedNextSnapshotScheduleTimeStatus -> (string)
The status of the next expected snapshot.
Valid values:
OnTrack|PendingHsmStatus -> (structure)
Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.
HsmClientCertificateIdentifier -> (string)
The name of the HSM client certificate that the Amazon Redshift cluster uses to retrieve the data encryption keys that are stored in an HSM.
HsmConfigurationIdentifier -> (string)
The name of the HSM configuration that contains the information that the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
Status -> (string)
Indicates whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Type: String
Valid values:
active|applyingIamRoles -> (list)
A list of IAM roles that the cluster can use to access other AWS services.
(structure)
An IAM role that the cluster can use to access other AWS services.
ApplyStatus -> (string)
The status of the IAM role’s association with the cluster.
Valid values:
in-sync|adding|removingIamRoleArn -> (string)
The ARN of the IAM role.
KmsKeyId -> (string)
The identifier of the AWS KMS encryption key that is used to encrypt data in the cluster.
MaintenanceTrackName -> (string)
The name of the maintenance track for the cluster.
ManualSnapshotRetentionPeriod -> (integer)
The default number of days to retain a manual snapshot.
If the value is -1, the snapshot is retained indefinitely.
This setting doesn’t change the retention period of existing snapshots.
Valid values: Either -1 or an integer between 1 and 3,653
MasterUsername -> (string)
The master user name for the cluster. This name is used to connect to the database that is specified in as the value of
DBName.NextMaintenanceWindowStartTime -> (string)
Indicates the start of the next maintenance window.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.NodeType -> (string)
The node type for the nodes in the cluster.
NumberOfNodes -> (integer)
The number of compute nodes in the cluster.
PendingActions -> (list)
A list of cluster operations that are waiting to start.
(string)
PendingModifiedValues -> (structure)
A list of changes to the cluster that are currently pending.
AutomatedSnapshotRetentionPeriod -> (integer)
The pending or in-progress change to the automated snapshot retention period.
ClusterIdentifier -> (string)
The pending or in-progress change to the identifier for the cluster.
ClusterType -> (string)
The pending or in-progress change to the cluster type.
ClusterVersion -> (string)
The pending or in-progress change to the service version.
EncryptionType -> (string)
The encryption type for a cluster.
EnhancedVpcRouting -> (boolean)
Indicates whether to create the cluster with enhanced VPC routing enabled.
MaintenanceTrackName -> (string)
The name of the maintenance track that the cluster changes to during the next maintenance window.
MasterUserPassword -> (string)
The pending or in-progress change to the master user password for the cluster.
NodeType -> (string)
The pending or in-progress change to the cluster’s node type.
NumberOfNodes -> (integer)
The pending or in-progress change to the number of nodes in the cluster.
PubliclyAccessible -> (boolean)
The pending or in-progress change to whether the cluster can be connected to from the public network.
PreferredMaintenanceWindow -> (string)
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
Format: `` <day> :HH:MM-<day> :HH:MM``
For the day values, use
mon|tue|wed|thu|fri|sat|sunFor example,
sun:09:32-sun:10:02PubliclyAccessible -> (boolean)
Whether the cluster can be accessed from a public network.
ResizeInfo -> (structure)
Information about the resize operation for the cluster.
AllowCancelResize -> (boolean)
Indicates whether the resize operation can be canceled.
ResizeType -> (string)
The type of resize operation.
Valid values:
ClassicResizeRestoreStatus -> (structure)
Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.
CurrentRestoreRateInMegaBytesPerSecond -> (double)
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
This field is only updated when you restore to DC2 and DS2 node types.
ElapsedTimeInSeconds -> (long)
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds -> (long)
The estimate of the time remaining before the restore is complete. Returns 0 for a completed restore.
This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes -> (long)
The number of megabytes that were transferred from snapshot storage.
This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes -> (long)
The size of the set of snapshot data that was used to restore the cluster.
This field is only updated when you restore to DC2 and DS2 node types.
Status -> (string)
The status of the restore action.
Valid values:
starting|restoring|completed|failedSnapshotScheduleIdentifier -> (string)
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState -> (string)
The current state of the cluster snapshot schedule.
Valid values:
MODIFYING|ACTIVE|FAILEDVpcId -> (string)
The identifier of the VPC that the cluster is in, if the cluster is in a VPC.
VpcSecurityGroups -> (list)
The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
(structure)
A VPC security group that the cluster belongs to, if the cluster is in a VPC.
Status -> (string)
The status of the VPC security group.
VpcSecurityGroupId -> (string)
The identifier of the VPC security group.
AwsElbLoadBalancer -> (structure)
contains details about a Classic Load Balancer.
AvailabilityZones -> (list)
The list of Availability Zones for the load balancer.
(string)
BackendServerDescriptions -> (list)
Information about the configuration of the EC2 instances.
(structure)
Provides information about the configuration of an EC2 instance for the load balancer.
InstancePort -> (integer)
The port on which the EC2 instance is listening.
PolicyNames -> (list)
The names of the policies that are enabled for the EC2 instance.
(string)
CanonicalHostedZoneName -> (string)
The name of the Amazon Route 53 hosted zone for the load balancer.
CanonicalHostedZoneNameID -> (string)
The ID of the Amazon Route 53 hosted zone for the load balancer.
CreatedTime -> (string)
Indicates when the load balancer was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.DnsName -> (string)
The DNS name of the load balancer.
HealthCheck -> (structure)
Information about the health checks that are conducted on the load balancer.
HealthyThreshold -> (integer)
The number of consecutive health check successes required before the instance is moved to the Healthy state.
Interval -> (integer)
The approximate interval, in seconds, between health checks of an individual instance.
Target -> (string)
The instance that is being checked. The target specifies the protocol and port. The available protocols are TCP, SSL, HTTP, and HTTPS. The range of valid ports is 1 through 65535.
For the HTTP and HTTPS protocols, the target also specifies the ping path.
For the TCP protocol, the target is specified as ``TCP: <port> `` .
For the SSL protocol, the target is specified as ``SSL.*<port>* `` .
For the HTTP and HTTPS protocols, the target is specified as `` <protocol> :<port> /<path to ping> `` .
Timeout -> (integer)
The amount of time, in seconds, during which no response means a failed health check.
UnhealthyThreshold -> (integer)
The number of consecutive health check failures that must occur before the instance is moved to the Unhealthy state.
Instances -> (list)
List of EC2 instances for the load balancer.
(structure)
Provides information about an EC2 instance for a load balancer.
InstanceId -> (string)
The instance identifier.
ListenerDescriptions -> (list)
The policies that are enabled for the load balancer listeners.
(structure)
Lists the policies that are enabled for a load balancer listener.
Listener -> (structure)
Information about the listener.
InstancePort -> (integer)
The port on which the instance is listening.
InstanceProtocol -> (string)
The protocol to use to route traffic to instances.
Valid values:
HTTP|HTTPS|TCP|SSLLoadBalancerPort -> (integer)
The port on which the load balancer is listening.
On EC2-VPC, you can specify any port from the range 1-65535.
On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
Protocol -> (string)
The load balancer transport protocol to use for routing.
Valid values:
HTTP|HTTPS|TCP|SSLSslCertificateId -> (string)
The ARN of the server certificate.
PolicyNames -> (list)
The policies enabled for the listener.
(string)
LoadBalancerAttributes -> (structure)
The attributes for a load balancer.
AccessLog -> (structure)
Information about the access log configuration for the load balancer.
If the access log is enabled, the load balancer captures detailed information about all requests. It delivers the information to a specified S3 bucket.
EmitInterval -> (integer)
The interval in minutes for publishing the access logs.
You can publish access logs either every 5 minutes or every 60 minutes.
Enabled -> (boolean)
Indicates whether access logs are enabled for the load balancer.
S3BucketName -> (string)
The name of the S3 bucket where the access logs are stored.
S3BucketPrefix -> (string)
The logical hierarchy that was created for the S3 bucket.
If a prefix is not provided, the log is placed at the root level of the bucket.
ConnectionDraining -> (structure)
Information about the connection draining configuration for the load balancer.
If connection draining is enabled, the load balancer allows existing requests to complete before it shifts traffic away from a deregistered or unhealthy instance.
Enabled -> (boolean)
Indicates whether connection draining is enabled for the load balancer.
Timeout -> (integer)
The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
ConnectionSettings -> (structure)
Connection settings for the load balancer.
If an idle timeout is configured, the load balancer allows connections to remain idle for the specified duration. When a connection is idle, no data is sent over the connection.
IdleTimeout -> (integer)
The time, in seconds, that the connection can be idle (no data is sent over the connection) before it is closed by the load balancer.
CrossZoneLoadBalancing -> (structure)
Cross-zone load balancing settings for the load balancer.
If cross-zone load balancing is enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
Enabled -> (boolean)
Indicates whether cross-zone load balancing is enabled for the load balancer.
LoadBalancerName -> (string)
The name of the load balancer.
Policies -> (structure)
The policies for a load balancer.
AppCookieStickinessPolicies -> (list)
The stickiness policies that are created using
CreateAppCookieStickinessPolicy.(structure)
Contains information about a stickiness policy that was created using
CreateAppCookieStickinessPolicy.CookieName -> (string)
The name of the application cookie used for stickiness.
PolicyName -> (string)
The mnemonic name for the policy being created. The name must be unique within the set of policies for the load balancer.
LbCookieStickinessPolicies -> (list)
The stickiness policies that are created using
CreateLBCookieStickinessPolicy.(structure)
Contains information about a stickiness policy that was created using
CreateLBCookieStickinessPolicy.CookieExpirationPeriod -> (long)
The amount of time, in seconds, after which the cookie is considered stale. If an expiration period is not specified, the stickiness session lasts for the duration of the browser session.
PolicyName -> (string)
The name of the policy. The name must be unique within the set of policies for the load balancer.
OtherPolicies -> (list)
The policies other than the stickiness policies.
(string)
Scheme -> (string)
The type of load balancer. Only provided if the load balancer is in a VPC.
If
Schemeisinternet-facing, the load balancer has a public DNS name that resolves to a public IP address.If
Schemeisinternal, the load balancer has a public DNS name that resolves to a private IP address.SecurityGroups -> (list)
The security groups for the load balancer. Only provided if the load balancer is in a VPC.
(string)
SourceSecurityGroup -> (structure)
Information about the security group for the load balancer. This is the security group that is used for inbound rules.
GroupName -> (string)
The name of the security group.
OwnerAlias -> (string)
The owner of the security group.
Subnets -> (list)
The list of subnet identifiers for the load balancer.
(string)
VpcId -> (string)
The identifier of the VPC for the load balancer.
AwsIamGroup -> (structure)
Contains details about an IAM group.
AttachedManagedPolicies -> (list)
A list of the managed policies that are attached to the IAM group.
(structure)
A managed policy that is attached to an IAM principal.
PolicyName -> (string)
The name of the policy.
PolicyArn -> (string)
The ARN of the policy.
CreateDate -> (string)
Indicates when the IAM group was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.GroupId -> (string)
The identifier of the IAM group.
GroupName -> (string)
The name of the IAM group.
GroupPolicyList -> (list)
The list of inline policies that are embedded in the group.
(structure)
A managed policy that is attached to the IAM group.
PolicyName -> (string)
The name of the policy.
Path -> (string)
The path to the group.
AwsIamRole -> (structure)
Details about an IAM role.
AssumeRolePolicyDocument -> (string)
The trust policy that grants permission to assume the role.
AttachedManagedPolicies -> (list)
The list of the managed policies that are attached to the role.
(structure)
A managed policy that is attached to an IAM principal.
PolicyName -> (string)
The name of the policy.
PolicyArn -> (string)
The ARN of the policy.
CreateDate -> (string)
Indicates when the role was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.InstanceProfileList -> (list)
The list of instance profiles that contain this role.
(structure)
Information about an instance profile.
Arn -> (string)
The ARN of the instance profile.
CreateDate -> (string)
Indicates when the instance profile was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.InstanceProfileId -> (string)
The identifier of the instance profile.
InstanceProfileName -> (string)
The name of the instance profile.
Path -> (string)
The path to the instance profile.
Roles -> (list)
The roles associated with the instance profile.
(structure)
Information about a role associated with an instance profile.
Arn -> (string)
The ARN of the role.
AssumeRolePolicyDocument -> (string)
The policy that grants an entity permission to assume the role.
CreateDate -> (string)
Indicates when the role was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Path -> (string)
The path to the role.
RoleId -> (string)
The identifier of the role.
RoleName -> (string)
The name of the role.
PermissionsBoundary -> (structure)
Information about the policy used to set the permissions boundary for an IAM principal.
PermissionsBoundaryArn -> (string)
The ARN of the policy used to set the permissions boundary.
PermissionsBoundaryType -> (string)
The usage type for the permissions boundary.
RoleId -> (string)
The stable and unique string identifying the role.
RoleName -> (string)
The friendly name that identifies the role.
RolePolicyList -> (list)
The list of inline policies that are embedded in the role.
(structure)
An inline policy that is embedded in the role.
PolicyName -> (string)
The name of the policy.
MaxSessionDuration -> (integer)
The maximum session duration (in seconds) that you want to set for the specified role.
Path -> (string)
The path to the role.
AwsKmsKey -> (structure)
Details about a KMS key.
AWSAccountId -> (string)
The twelve-digit account ID of the AWS account that owns the CMK.
CreationDate -> (double)
Indicates when the CMK was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.KeyId -> (string)
The globally unique identifier for the CMK.
KeyManager -> (string)
The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.
KeyState -> (string)
The state of the CMK.
Origin -> (string)
The source of the CMK’s key material.
When this value is
AWS_KMS, AWS KMS created the key material.When this value is
EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.When this value is
AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.Description -> (string)
A description of the key.
AwsLambdaFunction -> (structure)
Details about a Lambda function.
Code -> (structure)
An
AwsLambdaFunctionCodeobject.S3Bucket -> (string)
An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
S3Key -> (string)
The Amazon S3 key of the deployment package.
S3ObjectVersion -> (string)
For versioned objects, the version of the deployment package object to use.
ZipFile -> (string)
The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
CodeSha256 -> (string)
The SHA256 hash of the function’s deployment package.
DeadLetterConfig -> (structure)
The function’s dead letter queue.
TargetArn -> (string)
The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
Environment -> (structure)
The function’s environment variables.
Variables -> (map)
Environment variable key-value pairs.
key -> (string)
value -> (string)
Error -> (structure)
An
AwsLambdaFunctionEnvironmentErrorobject.ErrorCode -> (string)
The error code.
Message -> (string)
The error message.
FunctionName -> (string)
The name of the function.
Handler -> (string)
The function that Lambda calls to begin executing your function.
KmsKeyArn -> (string)
The KMS key that’s used to encrypt the function’s environment variables. This key is only returned if you’ve configured a customer managed CMK.
LastModified -> (string)
Indicates when the function was last updated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Layers -> (list)
The function’s layers.
(structure)
An AWS Lambda layer.
Arn -> (string)
The Amazon Resource Name (ARN) of the function layer.
CodeSize -> (integer)
The size of the layer archive in bytes.
MasterArn -> (string)
For Lambda@Edge functions, the ARN of the master function.
MemorySize -> (integer)
The memory that’s allocated to the function.
RevisionId -> (string)
The latest updated revision of the function or alias.
Role -> (string)
The function’s execution role.
Runtime -> (string)
The runtime environment for the Lambda function.
Timeout -> (integer)
The amount of time that Lambda allows a function to run before stopping it.
TracingConfig -> (structure)
The function’s AWS X-Ray tracing configuration.
Mode -> (string)
The tracing mode.
VpcConfig -> (structure)
The function’s networking configuration.
SecurityGroupIds -> (list)
A list of VPC security groups IDs.
(string)
SubnetIds -> (list)
A list of VPC subnet IDs.
(string)
VpcId -> (string)
The ID of the VPC.
Version -> (string)
The version of the Lambda function.
AwsLambdaLayerVersion -> (structure)
Details for a Lambda layer version.
Version -> (long)
The version number.
CompatibleRuntimes -> (list)
The layer’s compatible runtimes. Maximum number of five items.
Valid values:
nodejs10.x|nodejs12.x|java8|java11|python2.7|python3.6|python3.7|python3.8|dotnetcore1.0|dotnetcore2.1|go1.x|ruby2.5|provided(string)
CreatedDate -> (string)
Indicates when the version was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.AwsRdsDbInstance -> (structure)
Details about an Amazon RDS database instance.
AssociatedRoles -> (list)
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
(structure)
An AWS Identity and Access Management (IAM) role associated with the DB instance.
RoleArn -> (string)
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName -> (string)
The name of the feature associated with the IAM)role.
Status -> (string)
Describes the state of the association between the IAM role and the DB instance. The
Statusproperty returns one of the following values:
ACTIVE- The IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf.
PENDING- The IAM role ARN is being associated with the DB instance.
INVALID- The IAM role ARN is associated with the DB instance. But the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.CACertificateIdentifier -> (string)
The identifier of the CA certificate for this DB instance.
DBClusterIdentifier -> (string)
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
DBInstanceIdentifier -> (string)
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass -> (string)
Contains the name of the compute and memory capacity class of the DB instance.
DbInstancePort -> (integer)
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DbiResourceId -> (string)
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
DBName -> (string)
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
DeletionProtection -> (boolean)
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
Endpoint -> (structure)
Specifies the connection endpoint.
Address -> (string)
Specifies the DNS address of the DB instance.
Port -> (integer)
Specifies the port that the database engine is listening on.
HostedZoneId -> (string)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Engine -> (string)
Provides the name of the database engine to use for this DB instance.
EngineVersion -> (string)
Indicates the database engine version.
IAMDatabaseAuthenticationEnabled -> (boolean)
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines.
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher
InstanceCreateTime -> (string)
Indicates when the DB instance was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.KmsKeyId -> (string)
If
StorageEncryptedis true, the AWS KMS key identifier for the encrypted DB instance.PubliclyAccessible -> (boolean)
Specifies the accessibility options for the DB instance.
A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.
A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
StorageEncrypted -> (boolean)
Specifies whether the DB instance is encrypted.
TdeCredentialArn -> (string)
The ARN from the key store with which the instance is associated for TDE encryption.
VpcSecurityGroups -> (list)
A list of VPC security groups that the DB instance belongs to.
(structure)
A VPC security groups that the DB instance belongs to.
VpcSecurityGroupId -> (string)
The name of the VPC security group.
Status -> (string)
The status of the VPC security group.
MultiAz -> (boolean)
Whether the DB instance is a multiple Availability Zone deployment.
EnhancedMonitoringResourceArn -> (string)
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
DbInstanceStatus -> (string)
The current status of the DB instance.
MasterUsername -> (string)
The master user name of the DB instance.
AllocatedStorage -> (integer)
The amount of storage (in gigabytes) to initially allocate for the DB instance.
PreferredBackupWindow -> (string)
The range of time each day when automated backups are created, if automated backups are enabled.
Uses the format
HH:MM-HH:MM. For example,04:52-05:22.BackupRetentionPeriod -> (integer)
The number of days for which to retain automated backups.
DbSecurityGroups -> (list)
A list of the DB security groups to assign to the DB instance.
(string)
DbParameterGroups -> (list)
A list of the DB parameter groups to assign to the DB instance.
(structure)
Provides information about a parameter group for a DB instance.
DbParameterGroupName -> (string)
The name of the parameter group.
ParameterApplyStatus -> (string)
The status of parameter updates.
AvailabilityZone -> (string)
The Availability Zone where the DB instance will be created.
DbSubnetGroup -> (structure)
Information about the subnet group that is associated with the DB instance.
DbSubnetGroupName -> (string)
The name of the subnet group.
DbSubnetGroupDescription -> (string)
The description of the subnet group.
VpcId -> (string)
The VPC ID of the subnet group.
SubnetGroupStatus -> (string)
The status of the subnet group.
Subnets -> (list)
A list of subnets in the subnet group.
(structure)
Information about a subnet in a subnet group.
SubnetIdentifier -> (string)
The identifier of a subnet in the subnet group.
SubnetAvailabilityZone -> (structure)
Information about the Availability Zone for a subnet in the subnet group.
Name -> (string)
The name of the Availability Zone for a subnet in the subnet group.
SubnetStatus -> (string)
The status of a subnet in the subnet group.
DbSubnetGroupArn -> (string)
The ARN of the subnet group.
PreferredMaintenanceWindow -> (string)
PendingModifiedValues -> (structure)
Changes to the DB instance that are currently pending.
DbInstanceClass -> (string)
The new DB instance class for the DB instance.
AllocatedStorage -> (integer)
The new value of the allocated storage for the DB instance.
MasterUserPassword -> (string)
The new master user password for the DB instance.
Port -> (integer)
The new port for the DB instance.
BackupRetentionPeriod -> (integer)
The new backup retention period for the DB instance.
MultiAZ -> (boolean)
Indicates that a single Availability Zone DB instance is changing to a multiple Availability Zone deployment.
EngineVersion -> (string)
The new engine version for the DB instance.
LicenseModel -> (string)
The new license model value for the DB instance.
Iops -> (integer)
The new provisioned IOPS value for the DB instance.
DbInstanceIdentifier -> (string)
The new DB instance identifier for the DB instance.
StorageType -> (string)
The new storage type for the DB instance.
CaCertificateIdentifier -> (string)
The new CA certificate identifier for the DB instance.
DbSubnetGroupName -> (string)
The name of the new subnet group for the DB instance.
PendingCloudWatchLogsExports -> (structure)
A list of log types that are being enabled or disabled.
LogTypesToEnable -> (list)
A list of log types that are being enabled.
(string)
LogTypesToDisable -> (list)
A list of log types that are being disabled.
(string)
ProcessorFeatures -> (list)
Processor features that are being updated.
(structure)
A processor feature.
Name -> (string)
The name of the processor feature.
Value -> (string)
The value of the processor feature.
LatestRestorableTime -> (string)
Specifies the latest time to which a database can be restored with point-in-time restore.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.AutoMinorVersionUpgrade -> (boolean)
Indicates whether minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier -> (string)
If this DB instance is a read replica, contains the identifier of the source DB instance.
ReadReplicaDBInstanceIdentifiers -> (list)
List of identifiers of the read replicas associated with this DB instance.
(string)
ReadReplicaDBClusterIdentifiers -> (list)
List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
(string)
LicenseModel -> (string)
License model information for this DB instance.
Iops -> (integer)
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
OptionGroupMemberships -> (list)
The list of option group memberships for this DB instance.
(structure)
An option group membership.
OptionGroupName -> (string)
The name of the option group.
Status -> (string)
The status of the option group membership.
CharacterSetName -> (string)
The name of the character set that this DB instance is associated with.
SecondaryAvailabilityZone -> (string)
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
StatusInfos -> (list)
The status of a read replica. If the instance isn’t a read replica, this is empty.
(structure)
Information about the status of a read replica.
StatusType -> (string)
The type of status. For a read replica, the status type is read replication.
Normal -> (boolean)
Whether the read replica instance is operating normally.
Status -> (string)
The status of the read replica instance.
Message -> (string)
If the read replica is currently in an error state, provides the error details.
StorageType -> (string)
The storage type for the DB instance.
DomainMemberships -> (list)
The Active Directory domain membership records associated with the DB instance.
(structure)
Information about an Active Directory domain membership record associated with the DB instance.
Domain -> (string)
The identifier of the Active Directory domain.
Status -> (string)
The status of the Active Directory Domain membership for the DB instance.
Fqdn -> (string)
The fully qualified domain name of the Active Directory domain.
IamRoleName -> (string)
The name of the IAM role to use when making API calls to the Directory Service.
CopyTagsToSnapshot -> (boolean)
Whether to copy resource tags to snapshots of the DB instance.
MonitoringInterval -> (integer)
The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
MonitoringRoleArn -> (string)
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
PromotionTier -> (integer)
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
Timezone -> (string)
The time zone of the DB instance.
PerformanceInsightsEnabled -> (boolean)
Indicates whether Performance Insights is enabled for the DB instance.
PerformanceInsightsKmsKeyId -> (string)
The identifier of the AWS KMS key used to encrypt the Performance Insights data.
PerformanceInsightsRetentionPeriod -> (integer)
The number of days to retain Performance Insights data.
EnabledCloudWatchLogsExports -> (list)
A list of log types that this DB instance is configured to export to CloudWatch Logs.
(string)
ProcessorFeatures -> (list)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(structure)
A processor feature.
Name -> (string)
The name of the processor feature.
Value -> (string)
The value of the processor feature.
ListenerEndpoint -> (structure)
Specifies the connection endpoint.
Address -> (string)
Specifies the DNS address of the DB instance.
Port -> (integer)
Specifies the port that the database engine is listening on.
HostedZoneId -> (string)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
MaxAllocatedStorage -> (integer)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
AwsSnsTopic -> (structure)
Details about an SNS topic.
KmsMasterKeyId -> (string)
The ID of an AWS managed customer master key (CMK) for Amazon SNS or a custom CMK.
Subscription -> (list)
Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.
(structure)
A wrapper type for the attributes of an Amazon SNS subscription.
Endpoint -> (string)
The subscription’s endpoint (format depends on the protocol).
Protocol -> (string)
The subscription’s protocol.
TopicName -> (string)
The name of the topic.
Owner -> (string)
The subscription’s owner.
AwsSqsQueue -> (structure)
Details about an SQS queue.
KmsDataKeyReusePeriodSeconds -> (integer)
The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.
KmsMasterKeyId -> (string)
The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK.
QueueName -> (string)
The name of the new queue.
DeadLetterTargetArn -> (string)
The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of
maxReceiveCountis exceeded.AwsWafWebAcl -> (structure)
Details for a WAF WebACL.
Name -> (string)
A friendly name or description of the WebACL. You can’t change the name of a WebACL after you create it.
DefaultAction -> (string)
The action to perform if none of the rules contained in the WebACL match.
Rules -> (list)
An array that contains the action for each rule in a WebACL, the priority of the rule, and the ID of the rule.
(structure)
Details for a rule in a WAF WebACL.
Action -> (structure)
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule.
Type -> (string)
Specifies how you want AWS WAF to respond to requests that match the settings in a rule.
Valid settings include the following:
ALLOW- AWS WAF allows requests
BLOCK- AWS WAF blocks requests
COUNT- AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can’t specifyCOUNTfor the default action for a WebACL.ExcludedRules -> (list)
Rules to exclude from a rule group.
(structure)
Details about a rule to exclude from a rule group.
RuleId -> (string)
The unique identifier for the rule to exclude from the rule group.
OverrideAction -> (structure)
Use the
OverrideActionto test your RuleGroup.Any rule in a RuleGroup can potentially block a request. If you set the
OverrideActiontoNone, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.However, if you first want to test the RuleGroup, set the
OverrideActiontoCount. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.Type -> (string)
COUNToverrides the action specified by the individual rule within aRuleGroup.If set to
NONE, the rule’s action takes place.Priority -> (integer)
Specifies the order in which the rules in a WebACL are evaluated. Rules with a lower value for
Priorityare evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a WebACL, the values do not need to be consecutive.RuleId -> (string)
The identifier for a rule.
Type -> (string)
The rule type.
Valid values:
REGULAR|RATE_BASED|GROUPThe default is
REGULAR.WebAclId -> (string)
A unique identifier for a WebACL.
AwsRdsDbSnapshot -> (structure)
Details about an Amazon RDS database snapshot.
DbSnapshotIdentifier -> (string)
The name or ARN of the DB snapshot that is used to restore the DB instance.
DbInstanceIdentifier -> (string)
A name for the DB instance.
SnapshotCreateTime -> (string)
When the snapshot was taken in Coordinated Universal Time (UTC).
Engine -> (string)
The name of the database engine to use for this DB instance.
AllocatedStorage -> (integer)
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Status -> (string)
The status of this DB snapshot.
Port -> (integer)
The port that the database engine was listening on at the time of the snapshot.
AvailabilityZone -> (string)
Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.
VpcId -> (string)
The VPC ID associated with the DB snapshot.
InstanceCreateTime -> (string)
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername -> (string)
The master user name for the DB snapshot.
EngineVersion -> (string)
The version of the database engine.
LicenseModel -> (string)
License model information for the restored DB instance.
SnapshotType -> (string)
The type of the DB snapshot.
Iops -> (integer)
The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName -> (string)
The option group name for the DB snapshot.
PercentProgress -> (integer)
The percentage of the estimated data that has been transferred.
SourceRegion -> (string)
The AWS Region that the DB snapshot was created in or copied from.
SourceDbSnapshotIdentifier -> (string)
The DB snapshot ARN that the DB snapshot was copied from.
StorageType -> (string)
The storage type associated with the DB snapshot.
TdeCredentialArn -> (string)
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted -> (boolean)
Whether the DB snapshot is encrypted.
KmsKeyId -> (string)
If
Encryptedistrue, the AWS KMS key identifier for the encrypted DB snapshot.Timezone -> (string)
The time zone of the DB snapshot.
IamDatabaseAuthenticationEnabled -> (boolean)
Whether mapping of IAM accounts to database accounts is enabled.
ProcessorFeatures -> (list)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(structure)
A processor feature.
Name -> (string)
The name of the processor feature.
Value -> (string)
The value of the processor feature.
DbiResourceId -> (string)
The identifier for the source DB instance.
AwsRdsDbClusterSnapshot -> (structure)
Details about an Amazon RDS database cluster snapshot.
AvailabilityZones -> (list)
A list of Availability Zones where instances in the DB cluster can be created.
(string)
SnapshotCreateTime -> (string)
Indicates when the snapshot was taken.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Engine -> (string)
The name of the database engine that you want to use for this DB instance.
AllocatedStorage -> (integer)
Specifies the allocated storage size in gibibytes (GiB).
Status -> (string)
The status of this DB cluster snapshot.
Port -> (integer)
The port number on which the DB instances in the DB cluster accept connections.
VpcId -> (string)
The VPC ID that is associated with the DB cluster snapshot.
ClusterCreateTime -> (string)
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.MasterUsername -> (string)
The name of the master user for the DB cluster.
EngineVersion -> (string)
The version of the database engine to use.
LicenseModel -> (string)
The license model information for this DB cluster snapshot.
SnapshotType -> (string)
The type of DB cluster snapshot.
PercentProgress -> (integer)
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted -> (boolean)
Whether the DB cluster is encrypted.
KmsKeyId -> (string)
The ARN of the AWS KMS master key that is used to encrypt the database instances in the DB cluster.
DbClusterIdentifier -> (string)
The DB cluster identifier.
DbClusterSnapshotIdentifier -> (string)
The identifier of the DB cluster snapshot.
IamDatabaseAuthenticationEnabled -> (boolean)
Whether mapping of IAM accounts to database accounts is enabled.
AwsRdsDbCluster -> (structure)
Details about an Amazon RDS database cluster.
AllocatedStorage -> (integer)
For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).
AvailabilityZones -> (list)
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
(string)
BackupRetentionPeriod -> (integer)
The number of days for which automated backups are retained.
DatabaseName -> (string)
The name of the database.
Status -> (string)
The current status of this DB cluster.
Endpoint -> (string)
The connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint -> (string)
The reader endpoint for the DB cluster.
CustomEndpoints -> (list)
A list of custom endpoints for the DB cluster.
(string)
MultiAz -> (boolean)
Whether the DB cluster has instances in multiple Availability Zones.
Engine -> (string)
The name of the database engine to use for this DB cluster.
EngineVersion -> (string)
The version number of the database engine to use.
Port -> (integer)
The port number on which the DB instances in the DB cluster accept connections.
MasterUsername -> (string)
The name of the master user for the DB cluster.
PreferredBackupWindow -> (string)
The range of time each day when automated backups are created, if automated backups are enabled.
Uses the format
HH:MM-HH:MM. For example,04:52-05:22.PreferredMaintenanceWindow -> (string)
ReadReplicaIdentifiers -> (list)
The identifiers of the read replicas that are associated with this DB cluster.
(string)
VpcSecurityGroups -> (list)
A list of VPC security groups that the DB cluster belongs to.
(structure)
A VPC security groups that the DB instance belongs to.
VpcSecurityGroupId -> (string)
The name of the VPC security group.
Status -> (string)
The status of the VPC security group.
HostedZoneId -> (string)
Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted -> (boolean)
Whether the DB cluster is encrypted.
KmsKeyId -> (string)
The ARN of the AWS KMS master key that is used to encrypt the database instances in the DB cluster.
DbClusterResourceId -> (string)
The identifier of the DB cluster. The identifier must be unique within each AWS Region and is immutable.
AssociatedRoles -> (list)
A list of the IAM roles that are associated with the DB cluster.
(structure)
An IAM role that is associated with the Amazon RDS DB cluster.
RoleArn -> (string)
The ARN of the IAM role.
Status -> (string)
The status of the association between the IAM role and the DB cluster.
ClusterCreateTime -> (string)
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.EnabledCloudWatchLogsExports -> (list)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
(string)
EngineMode -> (string)
The database engine mode of the DB cluster.
DeletionProtection -> (boolean)
Whether the DB cluster has deletion protection enabled.
HttpEndpointEnabled -> (boolean)
Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
ActivityStreamStatus -> (string)
The status of the database activity stream.
CopyTagsToSnapshot -> (boolean)
Whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone -> (boolean)
Whether the DB cluster is a clone of a DB cluster owned by a different AWS account.
DomainMemberships -> (list)
The Active Directory domain membership records that are associated with the DB cluster.
(structure)
Information about an Active Directory domain membership record associated with the DB instance.
Domain -> (string)
The identifier of the Active Directory domain.
Status -> (string)
The status of the Active Directory Domain membership for the DB instance.
Fqdn -> (string)
The fully qualified domain name of the Active Directory domain.
IamRoleName -> (string)
The name of the IAM role to use when making API calls to the Directory Service.
DbClusterParameterGroup -> (string)
The name of the DB cluster parameter group for the DB cluster.
DbSubnetGroup -> (string)
The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.
DbClusterOptionGroupMemberships -> (list)
The list of option group memberships for this DB cluster.
(structure)
Information about an option group membership for a DB cluster.
DbClusterOptionGroupName -> (string)
The name of the DB cluster option group.
Status -> (string)
The status of the DB cluster option group.
DbClusterIdentifier -> (string)
The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.
DbClusterMembers -> (list)
The list of instances that make up the DB cluster.
(structure)
Information about an instance in the DB cluster.
IsClusterWriter -> (boolean)
Whether the cluster member is the primary instance for the DB cluster.
PromotionTier -> (integer)
Specifies the order in which an Aurora replica is promoted to the primary instance when the existing primary instance fails.
DbInstanceIdentifier -> (string)
The instance identifier for this member of the DB cluster.
DbClusterParameterGroupStatus -> (string)
The status of the DB cluster parameter group for this member of the DB cluster.
IamDatabaseAuthenticationEnabled -> (boolean)
Whether the mapping of IAM accounts to database accounts is enabled.
Container -> (structure)
Details about a container resource related to a finding.
Name -> (string)
The name of the container related to a finding.
ImageId -> (string)
The identifier of the image related to a finding.
ImageName -> (string)
The name of the image related to a finding.
LaunchedAt -> (string)
Indicates when the container started.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Other -> (map)
Details about a resource that are not available in a type-specific details object. Use the
Otherobject in the following cases.
The type-specific object does not contain all of the fields that you want to populate. In this case, first use the type-specific object to populate those fields. Use the
Otherobject to populate the fields that are missing from the type-specific object.The resource type does not have a corresponding object. This includes resources for which the type is
Other.key -> (string)
value -> (string)
Compliance -> (structure)
This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS AWS Foundations. Contains security standard-related finding details.
Status -> (string)
The result of a standards check.
The valid values for
Statusare as follows.
PASSED- Standards check passed for all evaluated resources.
WARNING- Some information is missing or this check is not supported for your configuration.
FAILED- Standards check failed for at least one evaluated resource.
NOT_AVAILABLE- Check could not be performed due to a service outage, API error, or because the result of the AWS Config evaluation wasNOT_APPLICABLE. If the AWS Config evaluation result wasNOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.RelatedRequirements -> (list)
For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.
(string)
StatusReasons -> (list)
For findings generated from controls, a list of reasons behind the value of
Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the AWS Security Hub User Guide .(structure)
Provides additional context for the value of
Compliance.Status.ReasonCode -> (string)
A code that represents a reason for the control status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the AWS Security Hub User Guide .
Description -> (string)
The corresponding description for the status reason code.
VerificationState -> (string)
Indicates the veracity of a finding.
WorkflowState -> (string)
The workflow state of a finding.
Workflow -> (structure)
Provides information about the status of the investigation into a finding.
Status -> (string)
The status of the investigation into the finding. The allowed values are the following.
NEW- The initial state of a finding, before it is reviewed. Security Hub also resets the workflow status fromNOTIFIEDorRESOLVEDtoNEWin the following cases:
RecordStatechanges fromARCHIVEDtoACTIVE.
ComplianceStatuschanges fromPASSEDto eitherWARNING,FAILED, orNOT_AVAILABLE.
NOTIFIED- Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
SUPPRESSED- The finding will not be reviewed again and will not be acted upon.
RESOLVED- The finding was reviewed and remediated and is now considered resolved.RecordState -> (string)
The record state of a finding.
RelatedFindings -> (list)
A list of related findings.
(structure)
Details about a related finding.
ProductArn -> (string)
The ARN of the product that generated a related finding.
Id -> (string)
The product-generated identifier for a related finding.
Note -> (structure)
A user-defined note added to a finding.
Text -> (string)
The text of a note.
UpdatedBy -> (string)
The principal that created a note.
UpdatedAt -> (string)
The timestamp of when the note was updated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.Vulnerabilities -> (list)
Provides a list of vulnerabilities associated with the findings.
(structure)
A vulnerability associated with a finding.
Id -> (string)
The identifier of the vulnerability.
VulnerablePackages -> (list)
List of software packages that have the vulnerability.
(structure)
Information about a software package.
Name -> (string)
The name of the software package.
Version -> (string)
The version of the software package.
Epoch -> (string)
The epoch of the software package.
Release -> (string)
The release of the software package.
Architecture -> (string)
The architecture used for the software package.
Cvss -> (list)
CVSS scores from the advisory related to the vulnerability.
(structure)
CVSS scores from the advisory related to the vulnerability.
Version -> (string)
The version of CVSS for the CVSS score.
BaseScore -> (double)
The base CVSS score.
BaseVector -> (string)
The base scoring vector for the CVSS score.
RelatedVulnerabilities -> (list)
List of vulnerabilities that are related to this vulnerability.
(string)
Vendor -> (structure)
Information about the vendor that generates the vulnerability report.
Name -> (string)
The name of the vendor.
Url -> (string)
The URL of the vulnerability advisory.
VendorSeverity -> (string)
The severity that the vendor assigned to the vulnerability.
VendorCreatedAt -> (string)
Indicates when the vulnerability advisory was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.VendorUpdatedAt -> (string)
Indicates when the vulnerability advisory was last updated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.ReferenceUrls -> (list)
A list of URLs that provide additional information about the vulnerability.
(string)
PatchSummary -> (structure)
Provides an overview of the patch compliance status for an instance against a selected compliance standard.
Id -> (string)
The identifier of the compliance standard that was used to determine the patch compliance status.
InstalledCount -> (integer)
The number of patches from the compliance standard that were installed successfully.
MissingCount -> (integer)
The number of patches that are part of the compliance standard but are not installed. The count includes patches that failed to install.
FailedCount -> (integer)
The number of patches from the compliance standard that failed to install.
InstalledOtherCount -> (integer)
The number of installed patches that are not part of the compliance standard.
InstalledRejectedCount -> (integer)
The number of patches that are installed but are also on a list of patches that the customer rejected.
InstalledPendingReboot -> (integer)
The number of patches that were applied, but that require the instance to be rebooted in order to be marked as installed.
OperationStartTime -> (string)
Indicates when the operation started.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.OperationEndTime -> (string)
Indicates when the operation completed.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format . The value cannot contain spaces. For example,2020-03-22T13:22:13.933Z.RebootOption -> (string)
The reboot option specified for the instance.
Operation -> (string)
The type of patch operation performed. For Patch Manager, the values are
SCANandINSTALL.Action -> (structure)
Provides details about an action that was detected for the finding.
ActionType -> (string)
The type of action that was detected. The possible action types are:
NETWORK_CONNECTION
AWS_API_CALL
DNS_REQUEST
PORT_PROBENetworkConnectionAction -> (structure)
Included if
ActionTypeisNETWORK_CONNECTION. Provides details about the network connection that was detected.ConnectionDirection -> (string)
The direction of the network connection request (
INorOUT).RemoteIpDetails -> (structure)
Information about the remote IP address that issued the network connection request.
IpAddressV4 -> (string)
The IP address.
Organization -> (structure)
The internet service provider (ISP) organization associated with the remote IP address.
Asn -> (integer)
The Autonomous System Number (ASN) of the internet provider
AsnOrg -> (string)
The name of the organization that registered the ASN.
Isp -> (string)
The ISP information for the internet provider.
Org -> (string)
The name of the internet provider.
Country -> (structure)
The country where the remote IP address is located.
CountryCode -> (string)
The 2-letter ISO 3166 country code for the country.
CountryName -> (string)
The name of the country.
City -> (structure)
The city where the remote IP address is located.
CityName -> (string)
The name of the city.
GeoLocation -> (structure)
The coordinates of the location of the remote IP address.
Lon -> (double)
The longitude of the location.
Lat -> (double)
The latitude of the location.
RemotePortDetails -> (structure)
Information about the port on the remote IP address.
Port -> (integer)
The number of the port.
PortName -> (string)
The port name of the remote connection.
LocalPortDetails -> (structure)
Information about the port on the EC2 instance.
Port -> (integer)
The number of the port.
PortName -> (string)
The port name of the local connection.
Protocol -> (string)
The protocol used to make the network connection request.
Blocked -> (boolean)
Indicates whether the network connection attempt was blocked.
AwsApiCallAction -> (structure)
Included if
ActionTypeisAWS_API_CALL. Provides details about the API call that was detected.Api -> (string)
The name of the API method that was issued.
ServiceName -> (string)
The name of the AWS service that the API method belongs to.
CallerType -> (string)
Indicates whether the API call originated from a remote IP address (
remoteip) or from a DNS domain (domain).RemoteIpDetails -> (structure)
Provided if
CallerTypeisremoteIp. Provides information about the remote IP address that the API call originated from.IpAddressV4 -> (string)
The IP address.
Organization -> (structure)
The internet service provider (ISP) organization associated with the remote IP address.
Asn -> (integer)
The Autonomous System Number (ASN) of the internet provider
AsnOrg -> (string)
The name of the organization that registered the ASN.
Isp -> (string)
The ISP information for the internet provider.
Org -> (string)
The name of the internet provider.
Country -> (structure)
The country where the remote IP address is located.
CountryCode -> (string)
The 2-letter ISO 3166 country code for the country.
CountryName -> (string)
The name of the country.
City -> (structure)
The city where the remote IP address is located.
CityName -> (string)
The name of the city.
GeoLocation -> (structure)
The coordinates of the location of the remote IP address.
Lon -> (double)
The longitude of the location.
Lat -> (double)
The latitude of the location.
DomainDetails -> (structure)
Provided if
CallerTypeisdomain. Provides information about the DNS domain that the API call originated from.Domain -> (string)
The name of the DNS domain that issued the API call.
AffectedResources -> (map)
Identifies the resources that were affected by the API call.
key -> (string)
value -> (string)
FirstSeen -> (string)
An ISO8601-formatted timestamp that indicates when the API call was first observed.
LastSeen -> (string)
An ISO8601-formatted timestamp that indicates when the API call was most recently observed.
DnsRequestAction -> (structure)
Included if
ActionTypeisDNS_REQUEST. Provides details about the DNS request that was detected.Domain -> (string)
The DNS domain that is associated with the DNS request.
Protocol -> (string)
The protocol that was used for the DNS request.
Blocked -> (boolean)
Indicates whether the DNS request was blocked.
PortProbeAction -> (structure)
Included if
ActionTypeisPORT_PROBE. Provides details about the port probe that was detected.PortProbeDetails -> (list)
Information about the ports affected by the port probe.
(structure)
A port scan that was part of the port probe. For each scan, PortProbeDetails provides information about the local IP address and port that were scanned, and the remote IP address that the scan originated from.
LocalPortDetails -> (structure)
Provides information about the port that was scanned.
Port -> (integer)
The number of the port.
PortName -> (string)
The port name of the local connection.
LocalIpDetails -> (structure)
Provides information about the IP address where the scanned port is located.
IpAddressV4 -> (string)
The IP address.
RemoteIpDetails -> (structure)
Provides information about the remote IP address that performed the scan.
IpAddressV4 -> (string)
The IP address.
Organization -> (structure)
The internet service provider (ISP) organization associated with the remote IP address.
Asn -> (integer)
The Autonomous System Number (ASN) of the internet provider
AsnOrg -> (string)
The name of the organization that registered the ASN.
Isp -> (string)
The ISP information for the internet provider.
Org -> (string)
The name of the internet provider.
Country -> (structure)
The country where the remote IP address is located.
CountryCode -> (string)
The 2-letter ISO 3166 country code for the country.
CountryName -> (string)
The name of the country.
City -> (structure)
The city where the remote IP address is located.
CityName -> (string)
The name of the city.
GeoLocation -> (structure)
The coordinates of the location of the remote IP address.
Lon -> (double)
The longitude of the location.
Lat -> (double)
The latitude of the location.
Blocked -> (boolean)
Indicates whether the port probe was blocked.
JSON Syntax:
[
{
"SchemaVersion": "string",
"Id": "string",
"ProductArn": "string",
"GeneratorId": "string",
"AwsAccountId": "string",
"Types": ["string", ...],
"FirstObservedAt": "string",
"LastObservedAt": "string",
"CreatedAt": "string",
"UpdatedAt": "string",
"Severity": {
"Product": double,
"Label": "INFORMATIONAL"|"LOW"|"MEDIUM"|"HIGH"|"CRITICAL",
"Normalized": integer,
"Original": "string"
},
"Confidence": integer,
"Criticality": integer,
"Title": "string",
"Description": "string",
"Remediation": {
"Recommendation": {
"Text": "string",
"Url": "string"
}
},
"SourceUrl": "string",
"ProductFields": {"string": "string"
...},
"UserDefinedFields": {"string": "string"
...},
"Malware": [
{
"Name": "string",
"Type": "ADWARE"|"BLENDED_THREAT"|"BOTNET_AGENT"|"COIN_MINER"|"EXPLOIT_KIT"|"KEYLOGGER"|"MACRO"|"POTENTIALLY_UNWANTED"|"SPYWARE"|"RANSOMWARE"|"REMOTE_ACCESS"|"ROOTKIT"|"TROJAN"|"VIRUS"|"WORM",
"Path": "string",
"State": "OBSERVED"|"REMOVAL_FAILED"|"REMOVED"
}
...
],
"Network": {
"Direction": "IN"|"OUT",
"Protocol": "string",
"OpenPortRange": {
"Begin": integer,
"End": integer
},
"SourceIpV4": "string",
"SourceIpV6": "string",
"SourcePort": integer,
"SourceDomain": "string",
"SourceMac": "string",
"DestinationIpV4": "string",
"DestinationIpV6": "string",
"DestinationPort": integer,
"DestinationDomain": "string"
},
"NetworkPath": [
{
"ComponentId": "string",
"ComponentType": "string",
"Egress": {
"Protocol": "string",
"Destination": {
"Address": ["string", ...],
"PortRanges": [
{
"Begin": integer,
"End": integer
}
...
]
},
"Source": {
"Address": ["string", ...],
"PortRanges": [
{
"Begin": integer,
"End": integer
}
...
]
}
},
"Ingress": {
"Protocol": "string",
"Destination": {
"Address": ["string", ...],
"PortRanges": [
{
"Begin": integer,
"End": integer
}
...
]
},
"Source": {
"Address": ["string", ...],
"PortRanges": [
{
"Begin": integer,
"End": integer
}
...
]
}
}
}
...
],
"Process": {
"Name": "string",
"Path": "string",
"Pid": integer,
"ParentPid": integer,
"LaunchedAt": "string",
"TerminatedAt": "string"
},
"ThreatIntelIndicators": [
{
"Type": "DOMAIN"|"EMAIL_ADDRESS"|"HASH_MD5"|"HASH_SHA1"|"HASH_SHA256"|"HASH_SHA512"|"IPV4_ADDRESS"|"IPV6_ADDRESS"|"MUTEX"|"PROCESS"|"URL",
"Value": "string",
"Category": "BACKDOOR"|"CARD_STEALER"|"COMMAND_AND_CONTROL"|"DROP_SITE"|"EXPLOIT_SITE"|"KEYLOGGER",
"LastObservedAt": "string",
"Source": "string",
"SourceUrl": "string"
}
...
],
"Resources": [
{
"Type": "string",
"Id": "string",
"Partition": "aws"|"aws-cn"|"aws-us-gov",
"Region": "string",
"ResourceRole": "string",
"Tags": {"string": "string"
...},
"Details": {
"AwsAutoScalingAutoScalingGroup": {
"LaunchConfigurationName": "string",
"LoadBalancerNames": ["string", ...],
"HealthCheckType": "string",
"HealthCheckGracePeriod": integer,
"CreatedTime": "string"
},
"AwsCodeBuildProject": {
"EncryptionKey": "string",
"Environment": {
"Certificate": "string",
"ImagePullCredentialsType": "string",
"RegistryCredential": {
"Credential": "string",
"CredentialProvider": "string"
},
"Type": "string"
},
"Name": "string",
"Source": {
"Type": "string",
"Location": "string",
"GitCloneDepth": integer,
"InsecureSsl": true|false
},
"ServiceRole": "string",
"VpcConfig": {
"VpcId": "string",
"Subnets": ["string", ...],
"SecurityGroupIds": ["string", ...]
}
},
"AwsCloudFrontDistribution": {
"CacheBehaviors": {
"Items": [
{
"ViewerProtocolPolicy": "string"
}
...
]
},
"DefaultCacheBehavior": {
"ViewerProtocolPolicy": "string"
},
"DefaultRootObject": "string",
"DomainName": "string",
"ETag": "string",
"LastModifiedTime": "string",
"Logging": {
"Bucket": "string",
"Enabled": true|false,
"IncludeCookies": true|false,
"Prefix": "string"
},
"Origins": {
"Items": [
{
"DomainName": "string",
"Id": "string",
"OriginPath": "string",
"S3OriginConfig": {
"OriginAccessIdentity": "string"
}
}
...
]
},
"OriginGroups": {
"Items": [
{
"FailoverCriteria": {
"StatusCodes": {
"Items": [integer, ...],
"Quantity": integer
}
}
}
...
]
},
"Status": "string",
"WebAclId": "string"
},
"AwsEc2Instance": {
"Type": "string",
"ImageId": "string",
"IpV4Addresses": ["string", ...],
"IpV6Addresses": ["string", ...],
"KeyName": "string",
"IamInstanceProfileArn": "string",
"VpcId": "string",
"SubnetId": "string",
"LaunchedAt": "string"
},
"AwsEc2NetworkInterface": {
"Attachment": {
"AttachTime": "string",
"AttachmentId": "string",
"DeleteOnTermination": true|false,
"DeviceIndex": integer,
"InstanceId": "string",
"InstanceOwnerId": "string",
"Status": "string"
},
"NetworkInterfaceId": "string",
"SecurityGroups": [
{
"GroupName": "string",
"GroupId": "string"
}
...
],
"SourceDestCheck": true|false,
"IpV6Addresses": [
{
"IpV6Address": "string"
}
...
],
"PrivateIpAddresses": [
{
"PrivateIpAddress": "string",
"PrivateDnsName": "string"
}
...
],
"PublicDnsName": "string",
"PublicIp": "string"
},
"AwsEc2SecurityGroup": {
"GroupName": "string",
"GroupId": "string",
"OwnerId": "string",
"VpcId": "string",
"IpPermissions": [
{
"IpProtocol": "string",
"FromPort": integer,
"ToPort": integer,
"UserIdGroupPairs": [
{
"GroupId": "string",
"GroupName": "string",
"PeeringStatus": "string",
"UserId": "string",
"VpcId": "string",
"VpcPeeringConnectionId": "string"
}
...
],
"IpRanges": [
{
"CidrIp": "string"
}
...
],
"Ipv6Ranges": [
{
"CidrIpv6": "string"
}
...
],
"PrefixListIds": [
{
"PrefixListId": "string"
}
...
]
}
...
],
"IpPermissionsEgress": [
{
"IpProtocol": "string",
"FromPort": integer,
"ToPort": integer,
"UserIdGroupPairs": [
{
"GroupId": "string",
"GroupName": "string",
"PeeringStatus": "string",
"UserId": "string",
"VpcId": "string",
"VpcPeeringConnectionId": "string"
}
...
],
"IpRanges": [
{
"CidrIp": "string"
}
...
],
"Ipv6Ranges": [
{
"CidrIpv6": "string"
}
...
],
"PrefixListIds": [
{
"PrefixListId": "string"
}
...
]
}
...
]
},
"AwsEc2Volume": {
"CreateTime": "string",
"Encrypted": true|false,
"Size": integer,
"SnapshotId": "string",
"Status": "string",
"KmsKeyId": "string",
"Attachments": [
{
"AttachTime": "string",
"DeleteOnTermination": true|false,
"InstanceId": "string",
"Status": "string"
}
...
]
},
"AwsEc2Vpc": {
"CidrBlockAssociationSet": [
{
"AssociationId": "string",
"CidrBlock": "string",
"CidrBlockState": "string"
}
...
],
"Ipv6CidrBlockAssociationSet": [
{
"AssociationId": "string",
"Ipv6CidrBlock": "string",
"CidrBlockState": "string"
}
...
],
"DhcpOptionsId": "string",
"State": "string"
},
"AwsEc2Eip": {
"InstanceId": "string",
"PublicIp": "string",
"AllocationId": "string",
"AssociationId": "string",
"Domain": "string",
"PublicIpv4Pool": "string",
"NetworkBorderGroup": "string",
"NetworkInterfaceId": "string",
"NetworkInterfaceOwnerId": "string",
"PrivateIpAddress": "string"
},
"AwsElbv2LoadBalancer": {
"AvailabilityZones": [
{
"ZoneName": "string",
"SubnetId": "string"
}
...
],
"CanonicalHostedZoneId": "string",
"CreatedTime": "string",
"DNSName": "string",
"IpAddressType": "string",
"Scheme": "string",
"SecurityGroups": ["string", ...],
"State": {
"Code": "string",
"Reason": "string"
},
"Type": "string",
"VpcId": "string"
},
"AwsElasticsearchDomain": {
"AccessPolicies": "string",
"DomainEndpointOptions": {
"EnforceHTTPS": true|false,
"TLSSecurityPolicy": "string"
},
"DomainId": "string",
"DomainName": "string",
"Endpoint": "string",
"Endpoints": {"string": "string"
...},
"ElasticsearchVersion": "string",
"EncryptionAtRestOptions": {
"Enabled": true|false,
"KmsKeyId": "string"
},
"NodeToNodeEncryptionOptions": {
"Enabled": true|false
},
"VPCOptions": {
"AvailabilityZones": ["string", ...],
"SecurityGroupIds": ["string", ...],
"SubnetIds": ["string", ...],
"VPCId": "string"
}
},
"AwsS3Bucket": {
"OwnerId": "string",
"OwnerName": "string",
"CreatedAt": "string",
"ServerSideEncryptionConfiguration": {
"Rules": [
{
"ApplyServerSideEncryptionByDefault": {
"SSEAlgorithm": "string",
"KMSMasterKeyID": "string"
}
}
...
]
}
},
"AwsS3Object": {
"LastModified": "string",
"ETag": "string",
"VersionId": "string",
"ContentType": "string",
"ServerSideEncryption": "string",
"SSEKMSKeyId": "string"
},
"AwsSecretsManagerSecret": {
"RotationRules": {
"AutomaticallyAfterDays": integer
},
"RotationOccurredWithinFrequency": true|false,
"KmsKeyId": "string",
"RotationEnabled": true|false,
"RotationLambdaArn": "string",
"Deleted": true|false,
"Name": "string",
"Description": "string"
},
"AwsIamAccessKey": {
"UserName": "string",
"Status": "Active"|"Inactive",
"CreatedAt": "string",
"PrincipalId": "string",
"PrincipalType": "string",
"PrincipalName": "string",
"AccountId": "string",
"AccessKeyId": "string",
"SessionContext": {
"Attributes": {
"MfaAuthenticated": true|false,
"CreationDate": "string"
},
"SessionIssuer": {
"Type": "string",
"PrincipalId": "string",
"Arn": "string",
"AccountId": "string",
"UserName": "string"
}
}
},
"AwsIamUser": {
"AttachedManagedPolicies": [
{
"PolicyName": "string",
"PolicyArn": "string"
}
...
],
"CreateDate": "string",
"GroupList": ["string", ...],
"Path": "string",
"PermissionsBoundary": {
"PermissionsBoundaryArn": "string",
"PermissionsBoundaryType": "string"
},
"UserId": "string",
"UserName": "string",
"UserPolicyList": [
{
"PolicyName": "string"
}
...
]
},
"AwsIamPolicy": {
"AttachmentCount": integer,
"CreateDate": "string",
"DefaultVersionId": "string",
"Description": "string",
"IsAttachable": true|false,
"Path": "string",
"PermissionsBoundaryUsageCount": integer,
"PolicyId": "string",
"PolicyName": "string",
"PolicyVersionList": [
{
"VersionId": "string",
"IsDefaultVersion": true|false,
"CreateDate": "string"
}
...
],
"UpdateDate": "string"
},
"AwsApiGatewayV2Stage": {
"CreatedDate": "string",
"Description": "string",
"DefaultRouteSettings": {
"DetailedMetricsEnabled": true|false,
"LoggingLevel": "string",
"DataTraceEnabled": true|false,
"ThrottlingBurstLimit": integer,
"ThrottlingRateLimit": double
},
"DeploymentId": "string",
"LastUpdatedDate": "string",
"RouteSettings": {
"DetailedMetricsEnabled": true|false,
"LoggingLevel": "string",
"DataTraceEnabled": true|false,
"ThrottlingBurstLimit": integer,
"ThrottlingRateLimit": double
},
"StageName": "string",
"StageVariables": {"string": "string"
...},
"AccessLogSettings": {
"Format": "string",
"DestinationArn": "string"
},
"AutoDeploy": true|false,
"LastDeploymentStatusMessage": "string",
"ApiGatewayManaged": true|false
},
"AwsApiGatewayV2Api": {
"ApiEndpoint": "string",
"ApiId": "string",
"ApiKeySelectionExpression": "string",
"CreatedDate": "string",
"Description": "string",
"Version": "string",
"Name": "string",
"ProtocolType": "string",
"RouteSelectionExpression": "string",
"CorsConfiguration": {
"AllowOrigins": ["string", ...],
"AllowCredentials": true|false,
"ExposeHeaders": ["string", ...],
"MaxAge": integer,
"AllowMethods": ["string", ...],
"AllowHeaders": ["string", ...]
}
},
"AwsDynamoDbTable": {
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
...
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": "string"
},
"CreationDateTime": "string",
"GlobalSecondaryIndexes": [
{
"Backfilling": true|false,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": long,
"IndexStatus": "string",
"ItemCount": integer,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
...
],
"Projection": {
"NonKeyAttributes": ["string", ...],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": "string",
"LastIncreaseDateTime": "string",
"NumberOfDecreasesToday": integer,
"ReadCapacityUnits": integer,
"WriteCapacityUnits": integer
}
}
...
],
"GlobalTableVersion": "string",
"ItemCount": integer,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
...
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
...
],
"Projection": {
"NonKeyAttributes": ["string", ...],
"ProjectionType": "string"
}
}
...
],
"ProvisionedThroughput": {
"LastDecreaseDateTime": "string",
"LastIncreaseDateTime": "string",
"NumberOfDecreasesToday": integer,
"ReadCapacityUnits": integer,
"WriteCapacityUnits": integer
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": integer
}
}
...
],
"KmsMasterKeyId": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": integer
},
"RegionName": "string",
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string"
}
...
],
"RestoreSummary": {
"SourceBackupArn": "string",
"SourceTableArn": "string",
"RestoreDateTime": "string",
"RestoreInProgress": true|false
},
"SseDescription": {
"InaccessibleEncryptionDateTime": "string",
"Status": "string",
"SseType": "string",
"KmsMasterKeyArn": "string"
},
"StreamSpecification": {
"StreamEnabled": true|false,
"StreamViewType": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": long,
"TableStatus": "string"
},
"AwsApiGatewayStage": {
"DeploymentId": "string",
"ClientCertificateId": "string",
"StageName": "string",
"Description": "string",
"CacheClusterEnabled": true|false,
"CacheClusterSize": "string",
"CacheClusterStatus": "string",
"MethodSettings": [
{
"MetricsEnabled": true|false,
"LoggingLevel": "string",
"DataTraceEnabled": true|false,
"ThrottlingBurstLimit": integer,
"ThrottlingRateLimit": double,
"CachingEnabled": true|false,
"CacheTtlInSeconds": integer,
"CacheDataEncrypted": true|false,
"RequireAuthorizationForCacheControl": true|false,
"UnauthorizedCacheControlHeaderStrategy": "string",
"HttpMethod": "string",
"ResourcePath": "string"
}
...
],
"Variables": {"string": "string"
...},
"DocumentationVersion": "string",
"AccessLogSettings": {
"Format": "string",
"DestinationArn": "string"
},
"CanarySettings": {
"PercentTraffic": double,
"DeploymentId": "string",
"StageVariableOverrides": {"string": "string"
...},
"UseStageCache": true|false
},
"TracingEnabled": true|false,
"CreatedDate": "string",
"LastUpdatedDate": "string",
"WebAclArn": "string"
},
"AwsApiGatewayRestApi": {
"Id": "string",
"Name": "string",
"Description": "string",
"CreatedDate": "string",
"Version": "string",
"BinaryMediaTypes": ["string", ...],
"MinimumCompressionSize": integer,
"ApiKeySource": "string",
"EndpointConfiguration": {
"Types": ["string", ...]
}
},
"AwsCloudTrailTrail": {
"CloudWatchLogsLogGroupArn": "string",
"CloudWatchLogsRoleArn": "string",
"HasCustomEventSelectors": true|false,
"HomeRegion": "string",
"IncludeGlobalServiceEvents": true|false,
"IsMultiRegionTrail": true|false,
"IsOrganizationTrail": true|false,
"KmsKeyId": "string",
"LogFileValidationEnabled": true|false,
"Name": "string",
"S3BucketName": "string",
"S3KeyPrefix": "string",
"SnsTopicArn": "string",
"SnsTopicName": "string",
"TrailArn": "string"
},
"AwsSsmPatchCompliance": {
"Patch": {
"ComplianceSummary": {
"Status": "string",
"CompliantCriticalCount": integer,
"CompliantHighCount": integer,
"CompliantMediumCount": integer,
"ExecutionType": "string",
"NonCompliantCriticalCount": integer,
"CompliantInformationalCount": integer,
"NonCompliantInformationalCount": integer,
"CompliantUnspecifiedCount": integer,
"NonCompliantLowCount": integer,
"NonCompliantHighCount": integer,
"CompliantLowCount": integer,
"ComplianceType": "string",
"PatchBaselineId": "string",
"OverallSeverity": "string",
"NonCompliantMediumCount": integer,
"NonCompliantUnspecifiedCount": integer,
"PatchGroup": "string"
}
}
},
"AwsCertificateManagerCertificate": {
"CertificateAuthorityArn": "string",
"CreatedAt": "string",
"DomainName": "string",
"DomainValidationOptions": [
{
"DomainName": "string",
"ResourceRecord": {
"Name": "string",
"Type": "string",
"Value": "string"
},
"ValidationDomain": "string",
"ValidationEmails": ["string", ...],
"ValidationMethod": "string",
"ValidationStatus": "string"
}
...
],
"ExtendedKeyUsages": [
{
"Name": "string",
"OId": "string"
}
...
],
"FailureReason": "string",
"ImportedAt": "string",
"InUseBy": ["string", ...],
"IssuedAt": "string",
"Issuer": "string",
"KeyAlgorithm": "string",
"KeyUsages": [
{
"Name": "string"
}
...
],
"NotAfter": "string",
"NotBefore": "string",
"Options": {
"CertificateTransparencyLoggingPreference": "string"
},
"RenewalEligibility": "string",
"RenewalSummary": {
"DomainValidationOptions": [
{
"DomainName": "string",
"ResourceRecord": {
"Name": "string",
"Type": "string",
"Value": "string"
},
"ValidationDomain": "string",
"ValidationEmails": ["string", ...],
"ValidationMethod": "string",
"ValidationStatus": "string"
}
...
],
"RenewalStatus": "string",
"RenewalStatusReason": "string",
"UpdatedAt": "string"
},
"Serial": "string",
"SignatureAlgorithm": "string",
"Status": "string",
"Subject": "string",
"SubjectAlternativeNames": ["string", ...],
"Type": "string"
},
"AwsRedshiftCluster": {
"AllowVersionUpgrade": true|false,
"AutomatedSnapshotRetentionPeriod": integer,
"AvailabilityZone": "string",
"ClusterAvailabilityStatus": "string",
"ClusterCreateTime": "string",
"ClusterIdentifier": "string",
"ClusterNodes": [
{
"NodeRole": "string",
"PrivateIpAddress": "string",
"PublicIpAddress": "string"
}
...
],
"ClusterParameterGroups": [
{
"ClusterParameterStatusList": [
{
"ParameterName": "string",
"ParameterApplyStatus": "string",
"ParameterApplyErrorDescription": "string"
}
...
],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
}
...
],
"ClusterPublicKey": "string",
"ClusterRevisionNumber": "string",
"ClusterSecurityGroups": [
{
"ClusterSecurityGroupName": "string",
"Status": "string"
}
...
],
"ClusterSnapshotCopyStatus": {
"DestinationRegion": "string",
"ManualSnapshotRetentionPeriod": integer,
"RetentionPeriod": integer,
"SnapshotCopyGrantName": "string"
},
"ClusterStatus": "string",
"ClusterSubnetGroupName": "string",
"ClusterVersion": "string",
"DBName": "string",
"DeferredMaintenanceWindows": [
{
"DeferMaintenanceEndTime": "string",
"DeferMaintenanceIdentifier": "string",
"DeferMaintenanceStartTime": "string"
}
...
],
"ElasticIpStatus": {
"ElasticIp": "string",
"Status": "string"
},
"ElasticResizeNumberOfNodeOptions": "string",
"Encrypted": true|false,
"Endpoint": {
"Address": "string",
"Port": integer
},
"EnhancedVpcRouting": true|false,
"ExpectedNextSnapshotScheduleTime": "string",
"ExpectedNextSnapshotScheduleTimeStatus": "string",
"HsmStatus": {
"HsmClientCertificateIdentifier": "string",
"HsmConfigurationIdentifier": "string",
"Status": "string"
},
"IamRoles": [
{
"ApplyStatus": "string",
"IamRoleArn": "string"
}
...
],
"KmsKeyId": "string",
"MaintenanceTrackName": "string",
"ManualSnapshotRetentionPeriod": integer,
"MasterUsername": "string",
"NextMaintenanceWindowStartTime": "string",
"NodeType": "string",
"NumberOfNodes": integer,
"PendingActions": ["string", ...],
"PendingModifiedValues": {
"AutomatedSnapshotRetentionPeriod": integer,
"ClusterIdentifier": "string",
"ClusterType": "string",
"ClusterVersion": "string",
"EncryptionType": "string",
"EnhancedVpcRouting": true|false,
"MaintenanceTrackName": "string",
"MasterUserPassword": "string",
"NodeType": "string",
"NumberOfNodes": integer,
"PubliclyAccessible": true|false
},
"PreferredMaintenanceWindow": "string",
"PubliclyAccessible": true|false,
"ResizeInfo": {
"AllowCancelResize": true|false,
"ResizeType": "string"
},
"RestoreStatus": {
"CurrentRestoreRateInMegaBytesPerSecond": double,
"ElapsedTimeInSeconds": long,
"EstimatedTimeToCompletionInSeconds": long,
"ProgressInMegaBytes": long,
"SnapshotSizeInMegaBytes": long,
"Status": "string"
},
"SnapshotScheduleIdentifier": "string",
"SnapshotScheduleState": "string",
"VpcId": "string",
"VpcSecurityGroups": [
{
"Status": "string",
"VpcSecurityGroupId": "string"
}
...
]
},
"AwsElbLoadBalancer": {
"AvailabilityZones": ["string", ...],
"BackendServerDescriptions": [
{
"InstancePort": integer,
"PolicyNames": ["string", ...]
}
...
],
"CanonicalHostedZoneName": "string",
"CanonicalHostedZoneNameID": "string",
"CreatedTime": "string",
"DnsName": "string",
"HealthCheck": {
"HealthyThreshold": integer,
"Interval": integer,
"Target": "string",
"Timeout": integer,
"UnhealthyThreshold": integer
},
"Instances": [
{
"InstanceId": "string"
}
...
],
"ListenerDescriptions": [
{
"Listener": {
"InstancePort": integer,
"InstanceProtocol": "string",
"LoadBalancerPort": integer,
"Protocol": "string",
"SslCertificateId": "string"
},
"PolicyNames": ["string", ...]
}
...
],
"LoadBalancerAttributes": {
"AccessLog": {
"EmitInterval": integer,
"Enabled": true|false,
"S3BucketName": "string",
"S3BucketPrefix": "string"
},
"ConnectionDraining": {
"Enabled": true|false,
"Timeout": integer
},
"ConnectionSettings": {
"IdleTimeout": integer
},
"CrossZoneLoadBalancing": {
"Enabled": true|false
}
},
"LoadBalancerName": "string",
"Policies": {
"AppCookieStickinessPolicies": [
{
"CookieName": "string",
"PolicyName": "string"
}
...
],
"LbCookieStickinessPolicies": [
{
"CookieExpirationPeriod": long,
"PolicyName": "string"
}
...
],
"OtherPolicies": ["string", ...]
},
"Scheme": "string",
"SecurityGroups": ["string", ...],
"SourceSecurityGroup": {
"GroupName": "string",
"OwnerAlias": "string"
},
"Subnets": ["string", ...],
"VpcId": "string"
},
"AwsIamGroup": {
"AttachedManagedPolicies": [
{
"PolicyName": "string",
"PolicyArn": "string"
}
...
],
"CreateDate": "string",
"GroupId": "string",
"GroupName": "string",
"GroupPolicyList": [
{
"PolicyName": "string"
}
...
],
"Path": "string"
},
"AwsIamRole": {
"AssumeRolePolicyDocument": "string",
"AttachedManagedPolicies": [
{
"PolicyName": "string",
"PolicyArn": "string"
}
...
],
"CreateDate": "string",
"InstanceProfileList": [
{
"Arn": "string",
"CreateDate": "string",
"InstanceProfileId": "string",
"InstanceProfileName": "string",
"Path": "string",
"Roles": [
{
"Arn": "string",
"AssumeRolePolicyDocument": "string",
"CreateDate": "string",
"Path": "string",
"RoleId": "string",
"RoleName": "string"
}
...
]
}
...
],
"PermissionsBoundary": {
"PermissionsBoundaryArn": "string",
"PermissionsBoundaryType": "string"
},
"RoleId": "string",
"RoleName": "string",
"RolePolicyList": [
{
"PolicyName": "string"
}
...
],
"MaxSessionDuration": integer,
"Path": "string"
},
"AwsKmsKey": {
"AWSAccountId": "string",
"CreationDate": double,
"KeyId": "string",
"KeyManager": "string",
"KeyState": "string",
"Origin": "string",
"Description": "string"
},
"AwsLambdaFunction": {
"Code": {
"S3Bucket": "string",
"S3Key": "string",
"S3ObjectVersion": "string",
"ZipFile": "string"
},
"CodeSha256": "string",
"DeadLetterConfig": {
"TargetArn": "string"
},
"Environment": {
"Variables": {"string": "string"
...},
"Error": {
"ErrorCode": "string",
"Message": "string"
}
},
"FunctionName": "string",
"Handler": "string",
"KmsKeyArn": "string",
"LastModified": "string",
"Layers": [
{
"Arn": "string",
"CodeSize": integer
}
...
],
"MasterArn": "string",
"MemorySize": integer,
"RevisionId": "string",
"Role": "string",
"Runtime": "string",
"Timeout": integer,
"TracingConfig": {
"Mode": "string"
},
"VpcConfig": {
"SecurityGroupIds": ["string", ...],
"SubnetIds": ["string", ...],
"VpcId": "string"
},
"Version": "string"
},
"AwsLambdaLayerVersion": {
"Version": long,
"CompatibleRuntimes": ["string", ...],
"CreatedDate": "string"
},
"AwsRdsDbInstance": {
"AssociatedRoles": [
{
"RoleArn": "string",
"FeatureName": "string",
"Status": "string"
}
...
],
"CACertificateIdentifier": "string",
"DBClusterIdentifier": "string",
"DBInstanceIdentifier": "string",
"DBInstanceClass": "string",
"DbInstancePort": integer,
"DbiResourceId": "string",
"DBName": "string",
"DeletionProtection": true|false,
"Endpoint": {
"Address": "string",
"Port": integer,
"HostedZoneId": "string"
},
"Engine": "string",
"EngineVersion": "string",
"IAMDatabaseAuthenticationEnabled": true|false,
"InstanceCreateTime": "string",
"KmsKeyId": "string",
"PubliclyAccessible": true|false,
"StorageEncrypted": true|false,
"TdeCredentialArn": "string",
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "string",
"Status": "string"
}
...
],
"MultiAz": true|false,
"EnhancedMonitoringResourceArn": "string",
"DbInstanceStatus": "string",
"MasterUsername": "string",
"AllocatedStorage": integer,
"PreferredBackupWindow": "string",
"BackupRetentionPeriod": integer,
"DbSecurityGroups": ["string", ...],
"DbParameterGroups": [
{
"DbParameterGroupName": "string",
"ParameterApplyStatus": "string"
}
...
],
"AvailabilityZone": "string",
"DbSubnetGroup": {
"DbSubnetGroupName": "string",
"DbSubnetGroupDescription": "string",
"VpcId": "string",
"SubnetGroupStatus": "string",
"Subnets": [
{
"SubnetIdentifier": "string",
"SubnetAvailabilityZone": {
"Name": "string"
},
"SubnetStatus": "string"
}
...
],
"DbSubnetGroupArn": "string"
},
"PreferredMaintenanceWindow": "string",
"PendingModifiedValues": {
"DbInstanceClass": "string",
"AllocatedStorage": integer,
"MasterUserPassword": "string",
"Port": integer,
"BackupRetentionPeriod": integer,
"MultiAZ": true|false,
"EngineVersion": "string",
"LicenseModel": "string",
"Iops": integer,
"DbInstanceIdentifier": "string",
"StorageType": "string",
"CaCertificateIdentifier": "string",
"DbSubnetGroupName": "string",
"PendingCloudWatchLogsExports": {
"LogTypesToEnable": ["string", ...],
"LogTypesToDisable": ["string", ...]
},
"ProcessorFeatures": [
{
"Name": "string",
"Value": "string"
}
...
]
},
"LatestRestorableTime": "string",
"AutoMinorVersionUpgrade": true|false,
"ReadReplicaSourceDBInstanceIdentifier": "string",
"ReadReplicaDBInstanceIdentifiers": ["string", ...],
"ReadReplicaDBClusterIdentifiers": ["string", ...],
"LicenseModel": "string",
"Iops": integer,
"OptionGroupMemberships": [
{
"OptionGroupName": "string",
"Status": "string"
}
...
],
"CharacterSetName": "string",
"SecondaryAvailabilityZone": "string",
"StatusInfos": [
{
"StatusType": "string",
"Normal": true|false,
"Status": "string",
"Message": "string"
}
...
],
"StorageType": "string",
"DomainMemberships": [
{
"Domain": "string",
"Status": "string",
"Fqdn": "string",
"IamRoleName": "string"
}
...
],
"CopyTagsToSnapshot": true|false,
"MonitoringInterval": integer,
"MonitoringRoleArn": "string",
"PromotionTier": integer,
"Timezone": "string",
"PerformanceInsightsEnabled": true|false,
"PerformanceInsightsKmsKeyId": "string",
"PerformanceInsightsRetentionPeriod": integer,
"EnabledCloudWatchLogsExports": ["string", ...],
"ProcessorFeatures": [
{
"Name": "string",
"Value": "string"
}
...
],
"ListenerEndpoint": {
"Address": "string",
"Port": integer,
"HostedZoneId": "string"
},
"MaxAllocatedStorage": integer
},
"AwsSnsTopic": {
"KmsMasterKeyId": "string",
"Subscription": [
{
"Endpoint": "string",
"Protocol": "string"
}
...
],
"TopicName": "string",
"Owner": "string"
},
"AwsSqsQueue": {
"KmsDataKeyReusePeriodSeconds": integer,
"KmsMasterKeyId": "string",
"QueueName": "string",
"DeadLetterTargetArn": "string"
},
"AwsWafWebAcl": {
"Name": "string",
"DefaultAction": "string",
"Rules": [
{
"Action": {
"Type": "string"
},
"ExcludedRules": [
{
"RuleId": "string"
}
...
],
"OverrideAction": {
"Type": "string"
},
"Priority": integer,
"RuleId": "string",
"Type": "string"
}
...
],
"WebAclId": "string"
},
"AwsRdsDbSnapshot": {
"DbSnapshotIdentifier": "string",
"DbInstanceIdentifier": "string",
"SnapshotCreateTime": "string",
"Engine": "string",
"AllocatedStorage": integer,
"Status": "string",
"Port": integer,
"AvailabilityZone": "string",
"VpcId": "string",
"InstanceCreateTime": "string",
"MasterUsername": "string",
"EngineVersion": "string",
"LicenseModel": "string",
"SnapshotType": "string",
"Iops": integer,
"OptionGroupName": "string",
"PercentProgress": integer,
"SourceRegion": "string",
"SourceDbSnapshotIdentifier": "string",
"StorageType": "string",
"TdeCredentialArn": "string",
"Encrypted": true|false,
"KmsKeyId": "string",
"Timezone": "string",
"IamDatabaseAuthenticationEnabled": true|false,
"ProcessorFeatures": [
{
"Name": "string",
"Value": "string"
}
...
],
"DbiResourceId": "string"
},
"AwsRdsDbClusterSnapshot": {
"AvailabilityZones": ["string", ...],
"SnapshotCreateTime": "string",
"Engine": "string",
"AllocatedStorage": integer,
"Status": "string",
"Port": integer,
"VpcId": "string",
"ClusterCreateTime": "string",
"MasterUsername": "string",
"EngineVersion": "string",
"LicenseModel": "string",
"SnapshotType": "string",
"PercentProgress": integer,
"StorageEncrypted": true|false,
"KmsKeyId": "string",
"DbClusterIdentifier": "string",
"DbClusterSnapshotIdentifier": "string",
"IamDatabaseAuthenticationEnabled": true|false
},
"AwsRdsDbCluster": {
"AllocatedStorage": integer,
"AvailabilityZones": ["string", ...],
"BackupRetentionPeriod": integer,
"DatabaseName": "string",
"Status": "string",
"Endpoint": "string",
"ReaderEndpoint": "string",
"CustomEndpoints": ["string", ...],
"MultiAz": true|false,
"Engine": "string",
"EngineVersion": "string",
"Port": integer,
"MasterUsername": "string",
"PreferredBackupWindow": "string",
"PreferredMaintenanceWindow": "string",
"ReadReplicaIdentifiers": ["string", ...],
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "string",
"Status": "string"
}
...
],
"HostedZoneId": "string",
"StorageEncrypted": true|false,
"KmsKeyId": "string",
"DbClusterResourceId": "string",
"AssociatedRoles": [
{
"RoleArn": "string",
"Status": "string"
}
...
],
"ClusterCreateTime": "string",
"EnabledCloudWatchLogsExports": ["string", ...],
"EngineMode": "string",
"DeletionProtection": true|false,
"HttpEndpointEnabled": true|false,
"ActivityStreamStatus": "string",
"CopyTagsToSnapshot": true|false,
"CrossAccountClone": true|false,
"DomainMemberships": [
{
"Domain": "string",
"Status": "string",
"Fqdn": "string",
"IamRoleName": "string"
}
...
],
"DbClusterParameterGroup": "string",
"DbSubnetGroup": "string",
"DbClusterOptionGroupMemberships": [
{
"DbClusterOptionGroupName": "string",
"Status": "string"
}
...
],
"DbClusterIdentifier": "string",
"DbClusterMembers": [
{
"IsClusterWriter": true|false,
"PromotionTier": integer,
"DbInstanceIdentifier": "string",
"DbClusterParameterGroupStatus": "string"
}
...
],
"IamDatabaseAuthenticationEnabled": true|false
},
"Container": {
"Name": "string",
"ImageId": "string",
"ImageName": "string",
"LaunchedAt": "string"
},
"Other": {"string": "string"
...}
}
}
...
],
"Compliance": {
"Status": "PASSED"|"WARNING"|"FAILED"|"NOT_AVAILABLE",
"RelatedRequirements": ["string", ...],
"StatusReasons": [
{
"ReasonCode": "string",
"Description": "string"
}
...
]
},
"VerificationState": "UNKNOWN"|"TRUE_POSITIVE"|"FALSE_POSITIVE"|"BENIGN_POSITIVE",
"WorkflowState": "NEW"|"ASSIGNED"|"IN_PROGRESS"|"DEFERRED"|"RESOLVED",
"Workflow": {
"Status": "NEW"|"NOTIFIED"|"RESOLVED"|"SUPPRESSED"
},
"RecordState": "ACTIVE"|"ARCHIVED",
"RelatedFindings": [
{
"ProductArn": "string",
"Id": "string"
}
...
],
"Note": {
"Text": "string",
"UpdatedBy": "string",
"UpdatedAt": "string"
},
"Vulnerabilities": [
{
"Id": "string",
"VulnerablePackages": [
{
"Name": "string",
"Version": "string",
"Epoch": "string",
"Release": "string",
"Architecture": "string"
}
...
],
"Cvss": [
{
"Version": "string",
"BaseScore": double,
"BaseVector": "string"
}
...
],
"RelatedVulnerabilities": ["string", ...],
"Vendor": {
"Name": "string",
"Url": "string",
"VendorSeverity": "string",
"VendorCreatedAt": "string",
"VendorUpdatedAt": "string"
},
"ReferenceUrls": ["string", ...]
}
...
],
"PatchSummary": {
"Id": "string",
"InstalledCount": integer,
"MissingCount": integer,
"FailedCount": integer,
"InstalledOtherCount": integer,
"InstalledRejectedCount": integer,
"InstalledPendingReboot": integer,
"OperationStartTime": "string",
"OperationEndTime": "string",
"RebootOption": "string",
"Operation": "string"
},
"Action": {
"ActionType": "string",
"NetworkConnectionAction": {
"ConnectionDirection": "string",
"RemoteIpDetails": {
"IpAddressV4": "string",
"Organization": {
"Asn": integer,
"AsnOrg": "string",
"Isp": "string",
"Org": "string"
},
"Country": {
"CountryCode": "string",
"CountryName": "string"
},
"City": {
"CityName": "string"
},
"GeoLocation": {
"Lon": double,
"Lat": double
}
},
"RemotePortDetails": {
"Port": integer,
"PortName": "string"
},
"LocalPortDetails": {
"Port": integer,
"PortName": "string"
},
"Protocol": "string",
"Blocked": true|false
},
"AwsApiCallAction": {
"Api": "string",
"ServiceName": "string",
"CallerType": "string",
"RemoteIpDetails": {
"IpAddressV4": "string",
"Organization": {
"Asn": integer,
"AsnOrg": "string",
"Isp": "string",
"Org": "string"
},
"Country": {
"CountryCode": "string",
"CountryName": "string"
},
"City": {
"CityName": "string"
},
"GeoLocation": {
"Lon": double,
"Lat": double
}
},
"DomainDetails": {
"Domain": "string"
},
"AffectedResources": {"string": "string"
...},
"FirstSeen": "string",
"LastSeen": "string"
},
"DnsRequestAction": {
"Domain": "string",
"Protocol": "string",
"Blocked": true|false
},
"PortProbeAction": {
"PortProbeDetails": [
{
"LocalPortDetails": {
"Port": integer,
"PortName": "string"
},
"LocalIpDetails": {
"IpAddressV4": "string"
},
"RemoteIpDetails": {
"IpAddressV4": "string",
"Organization": {
"Asn": integer,
"AsnOrg": "string",
"Isp": "string",
"Org": "string"
},
"Country": {
"CountryCode": "string",
"CountryName": "string"
},
"City": {
"CityName": "string"
},
"GeoLocation": {
"Lon": double,
"Lat": double
}
}
}
...
],
"Blocked": true|false
}
}
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To update a finding
The following batch-import-findings example updates a finding.
aws securityhub batch-import-findings \
--findings '
[{
"AwsAccountId": "123456789012",
"CreatedAt": "2020-05-27T17:05:54.832Z",
"Description": "Vulnerability in a CloudTrail trail",
"GeneratorId": "TestGeneratorId",
"Id": "Id1",
"ProductArn": "arn:aws:securityhub:us-west-1:123456789012:product/123456789012/default",
"Resources": [
{
"Id": "arn:aws:cloudtrail:us-west-1:123456789012:trail/TrailName",
"Partition": "aws",
"Region": "us-west-1",
"Type": "AwsCloudTrailTrail"
}
],
"SchemaVersion": "2018-10-08",
"Severity": {
"Label": "LOW",
"Product": 10
},
"Title": "CloudTrail trail vulnerability",
"Types": [
"Software and Configuration Checks/Vulnerabilities/CVE"
],
"UpdatedAt": "2020-06-02T16:05:54.832Z"
}]'
Output:
{
"FailedCount": 0,
"SuccessCount": 1,
"FailedFindings": []
}
For more information, see Using BatchImportFindings to create and update findings in the AWS Security Hub User Guide.
Output¶
FailedCount -> (integer)
The number of findings that failed to import.
SuccessCount -> (integer)
The number of findings that were successfully imported.
FailedFindings -> (list)
The list of findings that failed to import.
(structure)
The list of the findings that cannot be imported. For each finding, the list provides the error.
Id -> (string)
The identifier of the finding that could not be updated.
ErrorCode -> (string)
The code of the error returned by the
BatchImportFindingsoperation.ErrorMessage -> (string)
The message of the error returned by the
BatchImportFindingsoperation.