[ aws . securityhub ]
batch-import-findings¶
Description¶
Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub.
BatchImportFindingsmust be called by one of the following:
The account that is associated with the findings. The identifier of the associated account is the value of the
AwsAccountIdattribute for the finding.An account that is allow-listed for an official Security Hub partner integration.
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
Finding providers also should not use BatchImportFindings to update the following attributes.
ConfidenceCriticalityRelatedFindingsSeverityTypes
Instead, finding providers use FindingProviderFields to provide values for these attributes.
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 Amazon Web Services 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 Amazon Web Services security services and third-party solutions, and security standards checks.Note
A finding is a potential security issue generated either by Amazon Web Services services 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.
ProductName -> (string)
The name of the product that generated the finding.
Security Hub populates this attribute automatically for each finding. You cannot update it using
BatchImportFindingsorBatchUpdateFindings. The exception to this is when you use a custom integration.When you use the Security Hub console to filter findings by product name, you use this attribute.
When you use the Security Hub API to filter findings by product name, you use the
aws/securityhub/ProductNameattribute underProductFields.Security Hub does not synchronize those two attributes.
CompanyName -> (string)
The name of the company for the product that generated the finding.
Security Hub populates this attribute automatically for each finding. You cannot be updated using
BatchImportFindingsorBatchUpdateFindings. The exception to this is when you use a custom integration.When you use the Security Hub console to filter findings by company name, you use this attribute.
When you use the Security Hub API to filter findings by company name, you use the
aws/securityhub/CompanyNameattribute underProductFields.Security Hub does not synchronize those two attributes.
Region -> (string)
The Region from which the finding was generated.
Security Hub populates this attribute automatically for each finding. You cannot update it using
BatchImportFindingsorBatchUpdateFindings.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 Amazon Web Services 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 Amazon Web Services 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.Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.
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 Amazon Web Services partition name that the Region is assigned to.
Region -> (string)
The canonical Amazon Web Services 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 Amazon Web Services tags associated with a resource at the time the finding was processed.
key -> (string)
value -> (string)
DataClassification -> (structure)
Contains information about sensitive data that was detected on the resource.
DetailedResultsLocation -> (string)
The path to the folder or file that contains the sensitive data.
Result -> (structure)
The details about the sensitive data that was detected on the resource.
MimeType -> (string)
The type of content that the finding applies to.
SizeClassified -> (long)
The total size in bytes of the affected data.
AdditionalOccurrences -> (boolean)
Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.
Status -> (structure)
The current status of the sensitive data detection.
Code -> (string)
The code that represents the status of the sensitive data detection.
Reason -> (string)
A longer description of the current status of the sensitive data detection.
SensitiveData -> (list)
Provides details about sensitive data that was identified based on built-in configuration.
(structure)
Contains a detected instance of sensitive data that are based on built-in identifiers.
Category -> (string)
The category of sensitive data that was detected. For example, the category can indicate that the sensitive data involved credentials, financial information, or personal information.
Detections -> (list)
The list of detected instances of sensitive data.
(structure)
The list of detected instances of sensitive data.
Count -> (long)
The total number of occurrences of sensitive data that were detected.
Type -> (string)
The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.
Occurrences -> (structure)
Details about the sensitive data that was detected.
LineRanges -> (list)
Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.
(structure)
Identifies where the sensitive data begins and ends.
Start -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
End -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
StartColumn -> (long)
In the line where the sensitive data starts, the column within the line where the sensitive data starts.
OffsetRanges -> (list)
Occurrences of sensitive data detected in a binary text file.
(structure)
Identifies where the sensitive data begins and ends.
Start -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
End -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
StartColumn -> (long)
In the line where the sensitive data starts, the column within the line where the sensitive data starts.
Pages -> (list)
Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.
(structure)
An occurrence of sensitive data in an Adobe Portable Document Format (PDF) file.
PageNumber -> (long)
The page number of the page that contains the sensitive data.
LineRange -> (structure)
An occurrence of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.
Start -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
End -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
StartColumn -> (long)
In the line where the sensitive data starts, the column within the line where the sensitive data starts.
OffsetRange -> (structure)
An occurrence of sensitive data detected in a binary text file.
Start -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
End -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
StartColumn -> (long)
In the line where the sensitive data starts, the column within the line where the sensitive data starts.
Records -> (list)
Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.
(structure)
An occurrence of sensitive data in an Apache Avro object container or an Apache Parquet file.
JsonPath -> (string)
The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.
RecordIndex -> (long)
The record index, starting from 0, for the record that contains the data.
Cells -> (list)
Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.
(structure)
An occurrence of sensitive data detected in a Microsoft Excel workbook, comma-separated value (CSV) file, or tab-separated value (TSV) file.
Column -> (long)
The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.
Row -> (long)
The row number of the row that contains the data.
ColumnName -> (string)
The name of the column that contains the data.
CellReference -> (string)
For a Microsoft Excel workbook, provides the location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2.
TotalCount -> (long)
The total number of occurrences of sensitive data.
CustomDataIdentifiers -> (structure)
Provides details about sensitive data that was identified based on customer-defined configuration.
Detections -> (list)
The list of detected instances of sensitive data.
(structure)
The list of detected instances of sensitive data.
Count -> (long)
The total number of occurrences of sensitive data that were detected.
Arn -> (string)
The ARN of the custom identifier that was used to detect the sensitive data.
Name -> (string)
he name of the custom identifier that detected the sensitive data.
Occurrences -> (structure)
Details about the sensitive data that was detected.
LineRanges -> (list)
Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.
(structure)
Identifies where the sensitive data begins and ends.
Start -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
End -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
StartColumn -> (long)
In the line where the sensitive data starts, the column within the line where the sensitive data starts.
OffsetRanges -> (list)
Occurrences of sensitive data detected in a binary text file.
(structure)
Identifies where the sensitive data begins and ends.
Start -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
End -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
StartColumn -> (long)
In the line where the sensitive data starts, the column within the line where the sensitive data starts.
Pages -> (list)
Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.
(structure)
An occurrence of sensitive data in an Adobe Portable Document Format (PDF) file.
PageNumber -> (long)
The page number of the page that contains the sensitive data.
LineRange -> (structure)
An occurrence of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.
Start -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
End -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
StartColumn -> (long)
In the line where the sensitive data starts, the column within the line where the sensitive data starts.
OffsetRange -> (structure)
An occurrence of sensitive data detected in a binary text file.
Start -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
End -> (long)
The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
StartColumn -> (long)
In the line where the sensitive data starts, the column within the line where the sensitive data starts.
Records -> (list)
Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.
(structure)
An occurrence of sensitive data in an Apache Avro object container or an Apache Parquet file.
JsonPath -> (string)
The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.
RecordIndex -> (long)
The record index, starting from 0, for the record that contains the data.
Cells -> (list)
Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.
(structure)
An occurrence of sensitive data detected in a Microsoft Excel workbook, comma-separated value (CSV) file, or tab-separated value (TSV) file.
Column -> (long)
The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.
Row -> (long)
The row number of the row that contains the data.
ColumnName -> (string)
The name of the column that contains the data.
CellReference -> (string)
For a Microsoft Excel workbook, provides the location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2.
TotalCount -> (long)
The total number of occurrences of sensitive data.
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.MixedInstancesPolicy -> (structure)
The mixed instances policy for the automatic scaling group.
InstancesDistribution -> (structure)
The instances distribution. The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity.
OnDemandAllocationStrategy -> (string)
How to allocate instance types to fulfill On-Demand capacity.
OnDemandBaseCapacity -> (integer)
The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances.
OnDemandPercentageAboveBaseCapacity -> (integer)
The percentage of On-Demand Instances and Spot Instances for additional capacity beyond
OnDemandBaseCapacity.SpotAllocationStrategy -> (string)
How to allocate instances across Spot Instance pools.
SpotInstancePools -> (integer)
The number of Spot Instance pools across which to allocate your Spot Instances.
SpotMaxPrice -> (string)
The maximum price per unit hour that you are willing to pay for a Spot Instance.
LaunchTemplate -> (structure)
The launch template to use and the instance types (overrides) to use to provision EC2 instances to fulfill On-Demand and Spot capacities.
LaunchTemplateSpecification -> (structure)
The launch template to use.
LaunchTemplateId -> (string)
The identifier of the launch template. You must specify either
LaunchTemplateIdorLaunchTemplateName.LaunchTemplateName -> (string)
The name of the launch template. You must specify either
LaunchTemplateIdorLaunchTemplateName.Version -> (string)
Identifies the version of the launch template. You can specify a version identifier, or use the values
$Latestor$Default.Overrides -> (list)
Property values to use to override the values in the launch template.
(structure)
Property values to use to override the values in the launch template.
InstanceType -> (string)
The instance type. For example,
m3.xlarge.WeightedCapacity -> (string)
The number of capacity units provided by the specified instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic.
AvailabilityZones -> (list)
The list of Availability Zones for the automatic scaling group.
(structure)
An Availability Zone for the automatic scaling group.
Value -> (string)
The name of the Availability Zone.
AwsCodeBuildProject -> (structure)
Details for an CodeBuild project.
EncryptionKey -> (string)
The KMS key used to encrypt the build output artifacts.
You can specify either the ARN of the KMS key or, if available, the KMS key alias (using the format alias/alias-name).
Artifacts -> (list)
Information about the build artifacts for the CodeBuild project.
(structure)
Information about the build artifacts for the CodeBuild project.
ArtifactIdentifier -> (string)
An identifier for the artifact definition.
EncryptionDisabled -> (boolean)
Indicates whether to disable encryption on the artifact. Only valid when
TypeisS3.Location -> (string)
Only used when
TypeisS3. The name of the S3 bucket where the artifact is located.Name -> (string)
Only used when Type is S3. The name of the artifact. Used with
NamepaceTypeandPathto determine the pattern for storing the artifact.NamespaceType -> (string)
Only used when
TypeisS3. The value to use for the namespace. Used withNameandPathto determine the pattern for storing the artifact.OverrideArtifactName -> (boolean)
Whether the name specified in the buildspec file overrides the artifact name.
Packaging -> (string)
Only used when
TypeisS3. The type of output artifact to create.Path -> (string)
Only used when
TypeisS3. The path to the artifact. Used withNameandNamespaceTypeto determine the pattern for storing the artifact.Type -> (string)
The type of build artifact.
Environment -> (structure)
Information about the build environment for this build project.
Certificate -> (string)
The certificate to use with this build project.
EnvironmentVariables -> (list)
A set of environment variables to make available to builds for the build project.
(structure)
Information about an environment variable that is available to builds for the build project.
Name -> (string)
The name of the environment variable.
Type -> (string)
The type of environment variable.
Value -> (string)
The value of the environment variable.
PrivilegedMode -> (boolean)
Whether to allow the Docker daemon to run inside a Docker container. Set to
trueif the build project is used to build Docker images.ImagePullCredentialsType -> (string)
The type of credentials CodeBuild uses to pull images in your build.
Valid values:
CODEBUILDspecifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the CodeBuild service principal.
SERVICE_ROLEspecifies that 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 CodeBuild curated image, you must useCODEBUILDcredentials.RegistryCredential -> (structure)
The credentials for access to a private registry.
Credential -> (string)
The ARN or name of credentials created using Secrets Manager.
Note
The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.
CredentialProvider -> (string)
The service that created the credentials to access a private Docker registry.
The valid value,``SECRETS_MANAGER`` , is for 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 CodeCommit repository.
CODEPIPELINE- The source code settings are specified in the source action of a pipeline in 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 CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline’s source action instead of this value.
For source code in an 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 CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
LogsConfig -> (structure)
Information about logs for the build project.
CloudWatchLogs -> (structure)
Information about CloudWatch Logs for the build project.
GroupName -> (string)
The group name of the logs in CloudWatch Logs.
Status -> (string)
The current status of the logs in CloudWatch Logs for a build project.
StreamName -> (string)
The prefix of the stream name of the CloudWatch Logs.
S3Logs -> (structure)
Information about logs built to an S3 bucket for a build project.
EncryptionDisabled -> (boolean)
Whether to disable encryption of the S3 build log output.
Location -> (string)
The ARN of the S3 bucket and the path prefix for S3 logs.
Status -> (string)
The current status of the S3 build logs.
VpcConfig -> (structure)
Information about the VPC configuration that CodeBuild accesses.
VpcId -> (string)
The ID of the VPC.
Subnets -> (list)
A list of one or more subnet IDs in your VPC.
(string)
SecurityGroupIds -> (list)
A list of one or more security group IDs in your 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 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 S3 bucket, HTTP server (for example, a web server), AWS Elemental MediaStore, or other server from which CloudFront gets your files.
DomainName -> (string)
Amazon S3 origins: The DNS name of the 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.
ViewerCertificate -> (structure)
Provides information about the TLS/SSL configuration that the distribution uses to communicate with viewers.
AcmCertificateArn -> (string)
The ARN of the ACM certificate. Used if the certificate is stored in ACM. If you provide an ACM certificate ARN, you must also provide
MinimumCertificateVersionandSslSupportMethod.Certificate -> (string)
The identifier of the certificate. Note that in CloudFront, this attribute is deprecated.
CertificateSource -> (string)
The source of the certificate identified by
Certificate. Note that in CloudFront, this attribute is deprecated.CloudFrontDefaultCertificate -> (boolean)
Whether the distribution uses the CloudFront domain name. If set to
false, then you provide eitherAcmCertificateArnorIamCertificateId.IamCertificateId -> (string)
The identifier of the IAM certificate. Used if the certificate is stored in IAM. If you provide
IamCertificateId, then you also must provideMinimumProtocolVersionandSslSupportMethod.MinimumProtocolVersion -> (string)
The security policy that CloudFront uses for HTTPS connections with viewers. If
SslSupportMethodissni-only, thenMinimumProtocolVersionmust beTLSv1or higher.SslSupportMethod -> (string)
The viewers that the distribution accepts HTTPS connections from.
Status -> (string)
Indicates the current status of the distribution.
WebAclId -> (string)
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution.
AwsEc2Instance -> (structure)
Details about an 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.NetworkInterfaces -> (list)
The identifiers of the network interfaces for the EC2 instance. The details for each network interface are in a corresponding
AwsEc2NetworkInterfacesDetailsobject.(structure)
Identifies a network interface for the EC2 instance.
NetworkInterfaceId -> (string)
The identifier of the network interface. The details are in a corresponding
AwsEc2NetworkInterfacesDetailsobject.AwsEc2NetworkInterface -> (structure)
Details for an 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 VPC.
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 Amazon Web Services service. With outbound rules, this is the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 VPC.
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 Amazon Web Services service. With outbound rules, this is the Amazon Web Services 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 KMS key that was used to protect the volume encryption key for the volume.
Attachments -> (list)
The volume attachments.
(structure)
An attachment to an Amazon 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 Amazon Web Services 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 Amazon Web Services account ID of the owner of the network interface.
PrivateIpAddress -> (string)
The private IP address that is associated with the Elastic IP address.
AwsEc2Subnet -> (structure)
Details about a subnet in Amazon EC2.
AssignIpv6AddressOnCreation -> (boolean)
Whether to assign an IPV6 address to a network interface that is created in this subnet.
AvailabilityZone -> (string)
The Availability Zone for the subnet.
AvailabilityZoneId -> (string)
The identifier of the Availability Zone for the subnet.
AvailableIpAddressCount -> (integer)
The number of available IPV4 addresses in the subnet. Does not include addresses for stopped instances.
CidrBlock -> (string)
The IPV4 CIDR block that is assigned to the subnet.
DefaultForAz -> (boolean)
Whether this subnet is the default subnet for the Availability Zone.
MapPublicIpOnLaunch -> (boolean)
Whether instances in this subnet receive a public IP address.
OwnerId -> (string)
The identifier of the Amazon Web Services account that owns the subnet.
State -> (string)
The current state of the subnet.
SubnetArn -> (string)
The ARN of the subnet.
SubnetId -> (string)
The identifier of the subnet.
VpcId -> (string)
The identifier of the VPC that contains the subnet.
Ipv6CidrBlockAssociationSet -> (list)
The IPV6 CIDR blocks that are associated with the subnet.
(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.
AwsEc2NetworkAcl -> (structure)
Details about an EC2 network access control list (ACL).
IsDefault -> (boolean)
Whether this is the default network ACL for the VPC.
NetworkAclId -> (string)
The identifier of the network ACL.
OwnerId -> (string)
The identifier of the Amazon Web Services account that owns the network ACL.
VpcId -> (string)
The identifier of the VPC for the network ACL.
Associations -> (list)
Associations between the network ACL and subnets.
(structure)
An association between the network ACL and a subnet.
NetworkAclAssociationId -> (string)
The identifier of the association between the network ACL and the subnet.
NetworkAclId -> (string)
The identifier of the network ACL.
SubnetId -> (string)
The identifier of the subnet that is associated with the network ACL.
Entries -> (list)
The set of rules in the network ACL.
(structure)
A rule for the network ACL. Each rule allows or denies access based on the IP address, traffic direction, port, and protocol.
CidrBlock -> (string)
The IPV4 network range for which to deny or allow access.
Egress -> (boolean)
Whether the rule is an egress rule. An egress rule is a rule that applies to traffic that leaves the subnet.
IcmpTypeCode -> (structure)
The Internet Control Message Protocol (ICMP) type and code for which to deny or allow access.
Code -> (integer)
The ICMP code for which to deny or allow access. To deny or allow all codes, use the value -1.
Type -> (integer)
The ICMP type for which to deny or allow access. To deny or allow all types, use the value -1.
Ipv6CidrBlock -> (string)
The IPV6 network range for which to deny or allow access.
PortRange -> (structure)
For TCP or UDP protocols, the range of ports that the rule applies to.
From -> (integer)
The first port in the port range.
To -> (integer)
The last port in the port range.
Protocol -> (string)
The protocol that the rule applies to. To deny or allow access to all protocols, use the value -1.
RuleAction -> (string)
Whether the rule is used to allow access or deny access.
RuleNumber -> (integer)
The rule number. The rules are processed in order by their number.
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.
LoadBalancerAttributes -> (list)
Attributes of the load balancer.
(structure)
A load balancer attribute.
Key -> (string)
The name of the load balancer attribute.
Value -> (string)
The value of the load balancer attribute.
AwsElasticBeanstalkEnvironment -> (structure)
Details about an Elastic Beanstalk environment.
ApplicationName -> (string)
The name of the application that is associated with the environment.
Cname -> (string)
The URL to the CNAME for this environment.
DateCreated -> (string)
The creation date for this environment.
DateUpdated -> (string)
The date when this environment was last modified.
Description -> (string)
A description of the environment.
EndpointUrl -> (string)
For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.
EnvironmentArn -> (string)
The ARN of the environment.
EnvironmentId -> (string)
The identifier of the environment.
EnvironmentLinks -> (list)
Links to other environments in the same group.
(structure)
Contains information about a link to another environment that is in the same group.
EnvironmentName -> (string)
The name of the linked environment.
LinkName -> (string)
The name of the environment link.
EnvironmentName -> (string)
The name of the environment.
OptionSettings -> (list)
The configuration setting for the environment.
(structure)
A configuration option setting for the environment.
Namespace -> (string)
The type of resource that the configuration option is associated with.
OptionName -> (string)
The name of the option.
ResourceName -> (string)
The name of the resource.
Value -> (string)
The value of the configuration setting.
PlatformArn -> (string)
The ARN of the platform version for the environment.
SolutionStackName -> (string)
The name of the solution stack that is deployed with the environment.
Status -> (string)
The current operational status of the environment.
Tier -> (structure)
The tier of the environment.
Name -> (string)
The name of the environment tier.
Type -> (string)
The type of environment tier.
Version -> (string)
The version of the environment tier.
VersionLabel -> (string)
The application version of the environment.
AwsElasticsearchDomain -> (structure)
Details for an Elasticsearch domain.
AccessPolicies -> (string)
IAM policy document specifying the access policies for the new Elasticsearch 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 OpenSearch 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 Elasticsearch domain.
DomainName -> (string)
Name of an Elasticsearch domain.
Domain names are unique across all domains owned by the same account within an Amazon Web Services 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 Elasticsearch domain.
The endpoint is a service URL.
Endpoints -> (map)
The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.
key -> (string)
value -> (string)
ElasticsearchVersion -> (string)
OpenSearch version.
ElasticsearchClusterConfig -> (structure)
Information about an OpenSearch cluster configuration.
DedicatedMasterCount -> (integer)
The number of instances to use for the master node. If this attribute is specified, then
DedicatedMasterEnabledmust betrue.DedicatedMasterEnabled -> (boolean)
Whether to use a dedicated master node for the Elasticsearch domain. A dedicated master node performs cluster management tasks, but doesn’t hold data or respond to data upload requests.
DedicatedMasterType -> (string)
The hardware configuration of the computer that hosts the dedicated master node. For example,
m3.medium.elasticsearch. If this attribute is specified, thenDedicatedMasterEnabledmust betrue.InstanceCount -> (integer)
The number of data nodes to use in the Elasticsearch domain.
InstanceType -> (string)
The instance type for your data nodes. For example,
m3.medium.elasticsearch.ZoneAwarenessConfig -> (structure)
Configuration options for zone awareness. Provided if
ZoneAwarenessEnabledistrue.AvailabilityZoneCount -> (integer)
he number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.
ZoneAwarenessEnabled -> (boolean)
Whether to enable zone awareness for the Elasticsearch domain. When zone awareness is enabled, OpenSearch allocates the cluster’s nodes and replica index shards across Availability Zones in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
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.
LogPublishingOptions -> (structure)
Configures the CloudWatch Logs to publish for the Elasticsearch domain.
IndexSlowLogs -> (structure)
Configures the OpenSearch index logs publishing.
CloudWatchLogsLogGroupArn -> (string)
The ARN of the CloudWatch Logs group to publish the logs to.
Enabled -> (boolean)
Whether the log publishing is enabled.
SearchSlowLogs -> (structure)
Configures the OpenSearch search slow log publishing.
CloudWatchLogsLogGroupArn -> (string)
The ARN of the CloudWatch Logs group to publish the logs to.
Enabled -> (boolean)
Whether the log publishing is enabled.
AuditLogs -> (structure)
The log configuration.
CloudWatchLogsLogGroupArn -> (string)
The ARN of the CloudWatch Logs group to publish the logs to.
Enabled -> (boolean)
Whether the log publishing is enabled.
NodeToNodeEncryptionOptions -> (structure)
Details about the configuration for node-to-node encryption.
Enabled -> (boolean)
Whether node-to-node encryption is enabled.
ServiceSoftwareOptions -> (structure)
Information about the status of a domain relative to the latest service software.
AutomatedUpdateDate -> (string)
The epoch time when the deployment window closes for required updates. After this time, Amazon OpenSearch Service schedules the software upgrade automatically.
Cancellable -> (boolean)
Whether a request to update the domain can be canceled.
CurrentVersion -> (string)
The version of the service software that is currently installed on the domain.
Description -> (string)
A more detailed description of the service software status.
NewVersion -> (string)
The most recent version of the service software.
UpdateAvailable -> (boolean)
Whether a service software update is available for the domain.
UpdateStatus -> (string)
The status of the service software update.
VPCOptions -> (structure)
Information that OpenSearch 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 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.
OwnerAccountId -> (string)
The Amazon Web Services account identifier of the account that owns 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)
KMS key ID to use for the default encryption.
BucketLifecycleConfiguration -> (structure)
The lifecycle configuration for objects in the S3 bucket.
Rules -> (list)
The lifecycle rules.
(structure)
Configuration for a lifecycle rule.
AbortIncompleteMultipartUpload -> (structure)
How Amazon S3 responds when a multipart upload is incomplete. Specifically, provides a number of days before Amazon S3 cancels the entire upload.
DaysAfterInitiation -> (integer)
The number of days after which Amazon S3 cancels an incomplete multipart upload.
ExpirationDate -> (string)
The date when objects are moved or deleted.
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.ExpirationInDays -> (integer)
The length in days of the lifetime for objects that are subject to the rule.
ExpiredObjectDeleteMarker -> (boolean)
Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to
true, the delete marker is expired. If set tofalse, the policy takes no action.If you provide
ExpiredObjectDeleteMarker, you cannot provideExpirationInDaysorExpirationDate.Filter -> (structure)
Identifies the objects that a rule applies to.
Predicate -> (structure)
The configuration for the filter.
Operands -> (list)
The values to use for the filter.
(structure)
A value to use for the filter.
Prefix -> (string)
Prefix text for matching objects.
Tag -> (structure)
A tag that is assigned to matching objects.
Key -> (string)
The tag key.
Value -> (string)
The tag value.
Type -> (string)
The type of filter value.
Prefix -> (string)
A prefix filter.
Tag -> (structure)
A tag filter.
Key -> (string)
The tag key.
Value -> (string)
The tag value
Type -> (string)
Whether to use
ANDorORto join the operands.ID -> (string)
The unique identifier of the rule.
NoncurrentVersionExpirationInDays -> (integer)
The number of days that an object is noncurrent before Amazon S3 can perform the associated action.
NoncurrentVersionTransitions -> (list)
Transition rules that describe when noncurrent objects transition to a specified storage class.
(structure)
A transition rule that describes when noncurrent objects transition to a specified storage class.
Days -> (integer)
The number of days that an object is noncurrent before Amazon S3 can perform the associated action.
StorageClass -> (string)
The class of storage to change the object to after the object is noncurrent for the specified number of days.
Prefix -> (string)
A prefix that identifies one or more objects that the rule applies to.
Status -> (string)
The current status of the rule. Indicates whether the rule is currently being applied.
Transitions -> (list)
Transition rules that indicate when objects transition to a specified storage class.
(structure)
A rule for when objects transition to specific storage classes.
Date -> (string)
A date on which to transition objects to the specified storage class. If you provide
Date, you cannot provideDays.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.Days -> (integer)
The number of days after which to transition the object to the specified storage class. If you provide
Days, you cannot provideDate.StorageClass -> (string)
The storage class to transition the object to.
PublicAccessBlockConfiguration -> (structure)
Provides information about the Amazon S3 Public Access Block configuration for the S3 bucket.
BlockPublicAcls -> (boolean)
Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).
BlockPublicPolicy -> (boolean)
Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.
IgnorePublicAcls -> (boolean)
Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.
RestrictPublicBuckets -> (boolean)
Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only Amazon Web Services service principals and authorized users within the S3 bucket owner’s account.
AccessControlList -> (string)
The access control list for the S3 bucket.
BucketLoggingConfiguration -> (structure)
The logging configuration for the S3 bucket.
DestinationBucketName -> (string)
The name of the S3 bucket where log files for the S3 bucket are stored.
LogFilePrefix -> (string)
The prefix added to log files for the S3 bucket.
BucketWebsiteConfiguration -> (structure)
The website configuration parameters for the S3 bucket.
ErrorDocument -> (string)
The name of the error document for the website.
IndexDocumentSuffix -> (string)
The name of the index document for the website.
RedirectAllRequestsTo -> (structure)
The redirect behavior for requests to the website.
Hostname -> (string)
The name of the host to redirect requests to.
Protocol -> (string)
The protocol to use when redirecting requests. By default, uses the same protocol as the original request.
RoutingRules -> (list)
The rules for applying redirects for requests to the website.
(structure)
A rule for redirecting requests to the website.
Condition -> (structure)
Provides the condition that must be met in order to apply the routing rule.
HttpErrorCodeReturnedEquals -> (string)
Indicates to redirect the request if the HTTP error code matches this value.
KeyPrefixEquals -> (string)
Indicates to redirect the request if the key prefix matches this value.
Redirect -> (structure)
Provides the rules to redirect the request if the condition in
Conditionis met.Hostname -> (string)
The host name to use in the redirect request.
HttpRedirectCode -> (string)
The HTTP redirect code to use in the response.
Protocol -> (string)
The protocol to use to redirect the request. By default, uses the protocol from the original request.
ReplaceKeyPrefixWith -> (string)
The object key prefix to use in the redirect request.
Cannot be provided if
ReplaceKeyWithis present.ReplaceKeyWith -> (string)
The specific object key to use in the redirect request.
Cannot be provided if
ReplaceKeyPrefixWithis present.BucketNotificationConfiguration -> (structure)
The notification configuration for the S3 bucket.
Configurations -> (list)
Configurations for S3 bucket notifications.
(structure)
Details for an S3 bucket notification configuration.
Events -> (list)
The list of events that trigger a notification.
(string)
Filter -> (structure)
The filters that determine which S3 buckets generate notifications.
S3KeyFilter -> (structure)
Details for an Amazon S3 filter.
FilterRules -> (list)
The filter rules for the filter.
(structure)
Details for a filter rule.
Name -> (string)
Indicates whether the filter is based on the prefix or suffix of the Amazon S3 key.
Value -> (string)
The filter value.
Destination -> (string)
The ARN of the Lambda function, Amazon SQS queue, or Amazon SNS topic that generates the notification.
Type -> (string)
Indicates the type of notification. Notifications can be generated using Lambda functions, Amazon SQS queues or Amazon SNS topics.
BucketVersioningConfiguration -> (structure)
The versioning state of an S3 bucket.
IsMfaDeleteEnabled -> (boolean)
Specifies whether MFA delete is currently enabled in the S3 bucket versioning configuration. If the S3 bucket was never configured with MFA delete, then this attribute is not included.
Status -> (string)
The versioning status of the S3 bucket.
AwsS3AccountPublicAccessBlock -> (structure)
Details about the Amazon S3 Public Access Block configuration for an account.
BlockPublicAcls -> (boolean)
Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).
BlockPublicPolicy -> (boolean)
Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.
IgnorePublicAcls -> (boolean)
Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.
RestrictPublicBuckets -> (boolean)
Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only Amazon Web Services service principals and authorized users within the S3 bucket owner’s account.
AwsS3Object -> (structure)
Details about an 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 KMS symmetric customer managed key 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 KMS key 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 Amazon Web Services 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 Amazon Web Services 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.
ClientCertificateId -> (string)
The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
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 KMS key that will be used for 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 KMS key that is used for the 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 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 Events 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 Organizations, or only for the current Amazon Web Services account.
KmsKeyId -> (string)
The 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 Certificate Manager 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 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 Certificate Manager uses to send domain validation emails.
ValidationEmails -> (list)
A list of email addresses that 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 Amazon Web Services 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 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 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 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 Certificate Manager uses to send domain validation emails.
ValidationEmails -> (list)
A list of email addresses that 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 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 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 Amazon Web Services services.
(structure)
An IAM role that the cluster can use to access other Amazon Web Services 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 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 an KMS key.
AWSAccountId -> (string)
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
CreationDate -> (double)
Indicates when the KMS 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.KeyId -> (string)
The globally unique identifier for the KMS key.
KeyManager -> (string)
The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.
KeyState -> (string)
The state of the KMS key.
Origin -> (string)
The source of the KMS key material.
When this value is
AWS_KMS, KMS created the key material.When this value is
EXTERNAL, the key material was imported from your existing key management infrastructure or the KMS key lacks key material.When this value is
AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.Description -> (string)
A description of the key.
KeyRotationStatus -> (boolean)
Whether the key has key rotation enabled.
AwsLambdaFunction -> (structure)
Details about a Lambda function.
Code -> (structure)
An
AwsLambdaFunctionCodeobject.S3Bucket -> (string)
An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services 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. Amazon Web Services SDK and Amazon Web Services 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 ARN of an SQS queue or 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 is used to encrypt the function’s environment variables. This key is only returned if you’ve configured a customer managed customer managed key.
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 Lambda layer.
Arn -> (string)
The 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 is 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 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 IAM roles associated with the DB instance.
(structure)
An IAM role associated with the DB instance.
RoleArn -> (string)
The 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the 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 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 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 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 Amazon Web Services managed key for Amazon SNS or a customer managed key.
Subscription -> (list)
Subscription is an embedded property that describes the subscription endpoints of an 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 KMS again.
KmsMasterKeyId -> (string)
The ID of an Amazon Web Services managed key for Amazon SQS or a custom KMS key.
QueueName -> (string)
The name of the new queue.
DeadLetterTargetArn -> (string)
The ARN of the dead-letter queue to which Amazon SQS moves messages after the value of
maxReceiveCountis exceeded.AwsWafWebAcl -> (structure)
Details for an 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 an WAF WebACL.
Action -> (structure)
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
Type -> (string)
Specifies how you want WAF to respond to requests that match the settings in a rule.
Valid settings include the following:
ALLOW- WAF allows requests
BLOCK- WAF blocks requests
COUNT- WAF increments a counter of the requests that match all of the conditions in the rule. 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 Amazon Web Services 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 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 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 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 Amazon Web Services 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 Amazon Web Services 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.
AwsEcsCluster -> (structure)
Details about an ECS cluster.
CapacityProviders -> (list)
The short name of one or more capacity providers to associate with the cluster.
(string)
ClusterSettings -> (list)
The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.
(structure)
Indicates whether to enable CloudWatch Container Insights for the ECS cluster.
Name -> (string)
The name of the setting.
Value -> (string)
The value of the setting.
Configuration -> (structure)
The run command configuration for the cluster.
ExecuteCommandConfiguration -> (structure)
Contains the run command configuration for the cluster.
KmsKeyId -> (string)
The identifier of the KMS key that is used to encrypt the data between the local client and the container.
LogConfiguration -> (structure)
The log configuration for the results of the run command actions. Required if
LoggingisNONE.CloudWatchEncryptionEnabled -> (boolean)
Whether to enable encryption on the CloudWatch logs.
CloudWatchLogGroupName -> (string)
The name of the CloudWatch log group to send the logs to.
S3BucketName -> (string)
The name of the S3 bucket to send logs to.
S3EncryptionEnabled -> (boolean)
Whether to encrypt the logs that are sent to the S3 bucket.
S3KeyPrefix -> (string)
Identifies the folder in the S3 bucket to send the logs to.
Logging -> (string)
The log setting to use for redirecting logs for run command results.
DefaultCapacityProviderStrategy -> (list)
The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.
(structure)
The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.
Base -> (integer)
The minimum number of tasks to run on the specified capacity provider.
CapacityProvider -> (string)
The name of the capacity provider.
Weight -> (integer)
The relative percentage of the total number of tasks launched that should use the capacity provider.
AwsEcsTaskDefinition -> (structure)
Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.
ContainerDefinitions -> (list)
The container definitions that describe the containers that make up the task.
(structure)
A container definition that describes a container in the task.
Command -> (list)
The command that is passed to the container.
(string)
Cpu -> (integer)
The number of CPU units reserved for the container.
DependsOn -> (list)
The dependencies that are defined for container startup and shutdown.
(structure)
A dependency that is defined for container startup and shutdown.
Condition -> (string)
The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start.
ContainerName -> (string)
The name of the dependent container.
DisableNetworking -> (boolean)
Whether to disable networking within the container.
DnsSearchDomains -> (list)
A list of DNS search domains that are presented to the container.
(string)
DnsServers -> (list)
A list of DNS servers that are presented to the container.
(string)
DockerLabels -> (map)
A key-value map of labels to add to the container.
key -> (string)
value -> (string)
DockerSecurityOptions -> (list)
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
(string)
EntryPoint -> (list)
The entry point that is passed to the container.
(string)
Environment -> (list)
The environment variables to pass to a container.
(structure)
An environment variable to pass to the container.
Name -> (string)
The name of the environment variable.
Value -> (string)
The value of the environment variable.
EnvironmentFiles -> (list)
A list of files containing the environment variables to pass to a container.
(structure)
A file that contain environment variables to pass to a container.
Type -> (string)
The type of environment file.
Value -> (string)
The ARN of the S3 object that contains the environment variable file.
Essential -> (boolean)
Whether the container is essential. All tasks must have at least one essential container.
ExtraHosts -> (list)
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
(structure)
A hostname and IP address mapping to append to the /etc/hosts file on the container.
Hostname -> (string)
The hostname to use in the /etc/hosts entry.
IpAddress -> (string)
The IP address to use in the /etc/hosts entry.
FirelensConfiguration -> (structure)
The FireLens configuration for the container. Specifies and configures a log router for container logs.
Options -> (map)
The options to use to configure the log router.
The valid option keys are as follows:
enable-ecs-log-metadata. The value can betrueorfalse.
config-file-type. The value can bes3orfile.
config-file-value. The value is either an S3 ARN or a file path.key -> (string)
value -> (string)
Type -> (string)
The log router to use.
HealthCheck -> (structure)
The container health check command and associated configuration parameters for the container.
Command -> (list)
The command that the container runs to determine whether it is healthy.
(string)
Interval -> (integer)
The time period in seconds between each health check execution. The default value is 30 seconds.
Retries -> (integer)
The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.
StartPeriod -> (integer)
The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.
Timeout -> (integer)
The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.
Hostname -> (string)
The hostname to use for the container.
Image -> (string)
The image used to start the container.
Interactive -> (boolean)
If set to true, then containerized applications can be deployed that require
stdinor attyto be allocated.Links -> (list)
A list of links for the container in the form `` container_name :alias `` . Allows containers to communicate with each other without the need for port mappings.
(string)
LinuxParameters -> (structure)
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
Capabilities -> (structure)
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Add -> (list)
The Linux capabilities for the container that are added to the default configuration provided by Docker.
(string)
Drop -> (list)
The Linux capabilities for the container that are dropped from the default configuration provided by Docker.
(string)
Devices -> (list)
The host devices to expose to the container.
(structure)
A host device to expose to the container.
ContainerPath -> (string)
The path inside the container at which to expose the host device.
HostPath -> (string)
The path for the device on the host container instance.
Permissions -> (list)
The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and
mknodfor the device.(string)
InitProcessEnabled -> (boolean)
Whether to run an
initprocess inside the container that forwards signals and reaps processes.MaxSwap -> (integer)
The total amount of swap memory (in MiB) that a container can use.
SharedMemorySize -> (integer)
The value for the size (in MiB) of the /dev/shm volume.
Swappiness -> (integer)
Configures the container’s memory swappiness behavior. Determines how aggressively pages are swapped. The higher the value, the more aggressive the swappiness. The default is 60.
Tmpfs -> (list)
The container path, mount options, and size (in MiB) of the tmpfs mount.
(structure)
The container path, mount options, and size (in MiB) of a tmpfs mount.
ContainerPath -> (string)
The absolute file path where the tmpfs volume is to be mounted.
MountOptions -> (list)
The list of tmpfs volume mount options.
(string)
Size -> (integer)
The maximum size (in MiB) of the tmpfs volume.
LogConfiguration -> (structure)
The log configuration specification for the container.
LogDriver -> (string)
The log driver to use for the container.
Options -> (map)
The configuration options to send to the log driver. Requires version 1.19 of the Docker Remote API or greater on your container instance.
key -> (string)
value -> (string)
SecretOptions -> (list)
The secrets to pass to the log configuration.
(structure)
A secret to pass to the log configuration.
Name -> (string)
The name of the secret.
ValueFrom -> (string)
The secret to expose to the container.
The value is either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Systems Manager Parameter Store.
Memory -> (integer)
The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.
MemoryReservation -> (integer)
The soft limit (in MiB) of memory to reserve for the container.
MountPoints -> (list)
The mount points for the data volumes in the container.
(structure)
A mount point for the data volumes in the container.
ContainerPath -> (string)
The path on the container to mount the host volume at.
ReadOnly -> (boolean)
Whether the container has read-only access to the volume.
SourceVolume -> (string)
The name of the volume to mount. Must match the name of a volume listed in
VolumeDetailsfor the task definition.Name -> (string)
The name of the container.
PortMappings -> (list)
The list of port mappings for the container.
(structure)
A port mapping for the container.
ContainerPort -> (integer)
The port number on the container that is bound to the user-specified or automatically assigned host port.
HostPort -> (integer)
The port number on the container instance to reserve for the container.
Protocol -> (string)
The protocol used for the port mapping. The default is
tcp.Privileged -> (boolean)
Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.
PseudoTerminal -> (boolean)
Whether to allocate a TTY to the container.
ReadonlyRootFilesystem -> (boolean)
Whether the container is given read-only access to its root file system.
RepositoryCredentials -> (structure)
The private repository authentication credentials to use.
CredentialsParameter -> (string)
The ARN of the secret that contains the private repository credentials.
ResourceRequirements -> (list)
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
(structure)
A resource to assign to a container.
Type -> (string)
The type of resource to assign to a container.
Value -> (string)
The value for the specified resource type.
For
GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container.For
InferenceAccelerator, the value should match theDeviceNameattribute of an entry inInferenceAccelerators.Secrets -> (list)
The secrets to pass to the container.
(structure)
A secret to pass to the container.
Name -> (string)
The name of the secret.
ValueFrom -> (string)
The secret to expose to the container. The value is either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Systems Manager Parameter Store.
StartTimeout -> (integer)
The number of seconds to wait before giving up on resolving dependencies for a container.
StopTimeout -> (integer)
The number of seconds to wait before the container is stopped if it doesn’t shut down normally on its own.
SystemControls -> (list)
A list of namespaced kernel parameters to set in the container.
(structure)
A namespaced kernel parameter to set in the container.
Namespace -> (string)
The namespaced kernel parameter for which to set a value.
Value -> (string)
The value of the parameter.
Ulimits -> (list)
A list of ulimits to set in the container.
(structure)
A ulimit to set in the container.
HardLimit -> (integer)
The hard limit for the ulimit type.
Name -> (string)
The type of the ulimit.
SoftLimit -> (integer)
The soft limit for the ulimit type.
User -> (string)
VolumesFrom -> (list)
Data volumes to mount from another container.
(structure)
A data volume to mount from another container.
ReadOnly -> (boolean)
Whether the container has read-only access to the volume.
SourceContainer -> (string)
The name of another container within the same task definition from which to mount volumes.
WorkingDirectory -> (string)
The working directory in which to run commands inside the container.
Cpu -> (string)
The number of CPU units used by the task.
ExecutionRoleArn -> (string)
The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.
Family -> (string)
The name of a family that this task definition is registered to.
InferenceAccelerators -> (list)
The Elastic Inference accelerators to use for the containers in the task.
(structure)
An Elastic Inference accelerator to use for the containers in the task.
DeviceName -> (string)
The Elastic Inference accelerator device name.
DeviceType -> (string)
The Elastic Inference accelerator type to use.
IpcMode -> (string)
The IPC resource namespace to use for the containers in the task.
Memory -> (string)
The amount (in MiB) of memory used by the task.
NetworkMode -> (string)
The Docker networking mode to use for the containers in the task.
PidMode -> (string)
The process namespace to use for the containers in the task.
PlacementConstraints -> (list)
The placement constraint objects to use for tasks.
(structure)
A placement constraint object to use for tasks.
Expression -> (string)
A cluster query language expression to apply to the constraint.
Type -> (string)
The type of constraint.
ProxyConfiguration -> (structure)
The configuration details for the App Mesh proxy.
ContainerName -> (string)
The name of the container that will serve as the App Mesh proxy.
ProxyConfigurationProperties -> (list)
The set of network configuration parameters to provide to the Container Network Interface (CNI) plugin, specified as key-value pairs.
(structure)
A network configuration parameter to provide to the Container Network Interface (CNI) plugin.
Name -> (string)
The name of the property.
Value -> (string)
The value of the property.
Type -> (string)
The proxy type.
RequiresCompatibilities -> (list)
The task launch types that the task definition was validated against.
(string)
TaskRoleArn -> (string)
The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.
Volumes -> (list)
The data volume definitions for the task.
(structure)
A data volume to mount from another container.
DockerVolumeConfiguration -> (structure)
Information about a Docker volume.
Autoprovision -> (boolean)
Whether to create the Docker volume automatically if it does not already exist.
Driver -> (string)
The Docker volume driver to use.
DriverOpts -> (map)
A map of Docker driver-specific options that are passed through.
key -> (string)
value -> (string)
Labels -> (map)
Custom metadata to add to the Docker volume.
key -> (string)
value -> (string)
Scope -> (string)
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned automatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops.
EfsVolumeConfiguration -> (structure)
Information about the Amazon Elastic File System file system that is used for task storage.
AuthorizationConfig -> (structure)
The authorization configuration details for the Amazon EFS file system.
AccessPointId -> (string)
The Amazon EFS access point identifier to use.
Iam -> (string)
Whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.
FilesystemId -> (string)
The Amazon EFS file system identifier to use.
RootDirectory -> (string)
The directory within the Amazon EFS file system to mount as the root directory inside the host.
TransitEncryption -> (string)
Whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
TransitEncryptionPort -> (integer)
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
Host -> (structure)
Information about a bind mount host volume.
SourcePath -> (string)
The path on the host container instance that is presented to the container.
Name -> (string)
The name of the data volume.
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)
AwsRdsEventSubscription -> (structure)
Details about an RDS event notification subscription.
CustSubscriptionId -> (string)
The identifier of the account that is associated with the event notification subscription.
CustomerAwsId -> (string)
The identifier of the event notification subscription.
Enabled -> (boolean)
Whether the event notification subscription is enabled.
EventCategoriesList -> (list)
The list of event categories for the event notification subscription.
(string)
EventSubscriptionArn -> (string)
The ARN of the event notification subscription.
SnsTopicArn -> (string)
The ARN of the SNS topic to post the event notifications to.
SourceIdsList -> (list)
A list of source identifiers for the event notification subscription.
(string)
SourceType -> (string)
The source type for the event notification subscription.
Status -> (string)
The status of the event notification subscription.
Valid values:
creating|modifying|deleting|active|no-permission|topic-not-existSubscriptionCreationTime -> (string)
The datetime when the event notification subscription 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.AwsEcsService -> (structure)
Details about a service within an ECS cluster.
CapacityProviderStrategy -> (list)
The capacity provider strategy that the service uses.
(structure)
Strategy item for the capacity provider strategy that the service uses.
Base -> (integer)
The minimum number of tasks to run on the capacity provider. Only one strategy item can specify a value for
Base.The value must be between 0 and 100000.
CapacityProvider -> (string)
The short name of the capacity provider.
Weight -> (integer)
The relative percentage of the total number of tasks that should use the capacity provider.
If no weight is specified, the default value is 0. At least one capacity provider must have a weight greater than 0.
The value can be between 0 and 1000.
Cluster -> (string)
The ARN of the cluster that hosts the service.
DeploymentConfiguration -> (structure)
Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.
DeploymentCircuitBreaker -> (structure)
Determines whether a service deployment fails if a service cannot reach a steady state.
Enable -> (boolean)
Whether to enable the deployment circuit breaker logic for the service.
Rollback -> (boolean)
Whether to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
MaximumPercent -> (integer)
For a service that uses the rolling update (
ECS) deployment type, the maximum number of tasks in a service that are allowed in theRUNNINGorPENDINGstate during a deployment, and for tasks that use the EC2 launch type, when any container instances are in theDRAININGstate. Provided as a percentage of the desired number of tasks. The default value is 200%.For a service that uses the blue/green (
CODE_DEPLOY) orEXTERNALdeployment types, and tasks that use the EC2 launch type, the maximum number of tasks in the service that remain in theRUNNINGstate while the container instances are in theDRAININGstate.For the Fargate launch type, the maximum percent value is not used.
MinimumHealthyPercent -> (integer)
For a service that uses the rolling update (
ECS) deployment type, the minimum number of tasks in a service that must remain in theRUNNINGstate during a deployment, and while any container instances are in theDRAININGstate if the service contains tasks using the EC2 launch type. Expressed as a percentage of the desired number of tasks. The default value is 100%.For a service that uses the blue/green (
CODE_DEPLOY) orEXTERNALdeployment types and tasks that use the EC2 launch type, the minimum number of the tasks in the service that remain in theRUNNINGstate while the container instances are in theDRAININGstate.For the Fargate launch type, the minimum healthy percent value is not used.
DeploymentController -> (structure)
Contains the deployment controller type that the service uses.
Type -> (string)
The rolling update (
ECS) deployment type replaces the current running version of the container with the latest version.The blue/green (
CODE_DEPLOY) deployment type uses the blue/green deployment model that is powered by CodeDeploy. This deployment model a new deployment of a service can be verified before production traffic is sent to it.The external (
EXTERNAL) deployment type allows the use of any third-party deployment controller for full control over the deployment process for an Amazon ECS service.Valid values:
ECS|CODE_DEPLOY|EXTERNALDesiredCount -> (integer)
The number of instantiations of the task definition to run on the service.
EnableEcsManagedTags -> (boolean)
Whether to enable Amazon ECS managed tags for the tasks in the service.
EnableExecuteCommand -> (boolean)
Whether the execute command functionality is enabled for the service.
HealthCheckGracePeriodSeconds -> (integer)
After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.
LaunchType -> (string)
The launch type that the service uses.
Valid values:
EC2|FARGATE|EXTERNALLoadBalancers -> (list)
Information about the load balancers that the service uses.
(structure)
Information about a load balancer that the service uses.
ContainerName -> (string)
The name of the container to associate with the load balancer.
ContainerPort -> (integer)
The port on the container to associate with the load balancer. This port must correspond to a
containerPortin the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on thehostPortof the port mapping.LoadBalancerName -> (string)
The name of the load balancer to associate with the Amazon ECS service or task set.
Only specified when using a Classic Load Balancer. For an Application Load Balancer or a Network Load Balancer, the load balancer name is omitted.
TargetGroupArn -> (string)
The ARN of the Elastic Load Balancing target group or groups associated with a service or task set.
Only specified when using an Application Load Balancer or a Network Load Balancer. For a Classic Load Balancer, the target group ARN is omitted.
Name -> (string)
The name of the service.
NetworkConfiguration -> (structure)
For tasks that use the
awsvpcnetworking mode, the VPC subnet and security group configuration.AwsVpcConfiguration -> (structure)
The VPC subnet and security group configuration.
AssignPublicIp -> (string)
Whether the task’s elastic network interface receives a public IP address. The default value is
DISABLED.Valid values:
ENABLED|DISABLEDSecurityGroups -> (list)
The IDs of the security groups associated with the task or service.
You can provide up to five security groups.
(string)
Subnets -> (list)
The IDs of the subnets associated with the task or service.
You can provide up to 16 subnets.
(string)
PlacementConstraints -> (list)
The placement constraints for the tasks in the service.
(structure)
A placement constraint for the tasks in the service.
Expression -> (string)
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is
distinctInstance.Type -> (string)
The type of constraint. Use
distinctInstanceto run each task in a particular group on a different container instance. UsememberOfto restrict the selection to a group of valid candidates.Valid values:
distinctInstance|memberOfPlacementStrategies -> (list)
Information about how tasks for the service are placed.
(structure)
A placement strategy that determines how to place the tasks for the service.
Field -> (string)
The field to apply the placement strategy against.
For the
spreadplacement strategy, valid values areinstanceId(orhost, which has the same effect), or any platform or custom attribute that is applied to a container instance, such asattribute:ecs.availability-zone.For the
binpackplacement strategy, valid values arecpuandmemory.For the
randomplacement strategy, this attribute is not used.Type -> (string)
The type of placement strategy.
The
randomplacement strategy randomly places tasks on available candidates.The
spreadplacement strategy spreads placement across available candidates evenly based on the value ofField.The
binpackstrategy places tasks on available candidates that have the least available amount of the resource that is specified inField.Valid values:
random|spread|binpackPlatformVersion -> (string)
The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the
LATESTplatform version is used by default.PropagateTags -> (string)
Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.
Valid values:
TASK_DEFINITION|SERVICERole -> (string)
The ARN of the IAM role that is associated with the service. The role allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
SchedulingStrategy -> (string)
The scheduling strategy to use for the service.
The
REPLICAscheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.The
DAEMONscheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that do not meet the placement constraints.Valid values:
REPLICA|DAEMONServiceArn -> (string)
The ARN of the service.
ServiceName -> (string)
The name of the service.
The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.
ServiceRegistries -> (list)
Information about the service discovery registries to assign to the service.
(structure)
Information about a service discovery registry to assign to the service.
ContainerName -> (string)
The container name value to use for the service discovery service.
If the task definition uses the
bridgeorhostnetwork mode, you must specifyContainerNameandContainerPort.If the task definition uses the
awsvpcnetwork mode and a type SRV DNS record, you must specify eitherContainerNameandContainerPort, orPort, but not both.ContainerPort -> (integer)
The port value to use for the service discovery service.
If the task definition uses the
bridgeorhostnetwork mode, you must specifyContainerNameandContainerPort.If the task definition uses the
awsvpcnetwork mode and a type SRV DNS record, you must specify eitherContainerNameandContainerPort, orPort, but not both.Port -> (integer)
The port value to use for a service discovery service that specifies an SRV record. This field can be used if both the
awsvpcawsvpc network mode and SRV records are used.RegistryArn -> (string)
The ARN of the service registry.
TaskDefinition -> (string)
The task definition to use for tasks in the service.
AwsAutoScalingLaunchConfiguration -> (structure)
Provides details about a launch configuration.
AssociatePublicIpAddress -> (boolean)
For Auto Scaling groups that run in a VPC, specifies whether to assign a public IP address to the group’s instances.
BlockDeviceMappings -> (list)
Specifies the block devices for the instance.
(structure)
A block device for the instance.
DeviceName -> (string)
The device name that is exposed to the EC2 instance. For example,
/dev/sdhorxvdh.Ebs -> (structure)
Parameters that are used to automatically set up Amazon EBS volumes when an instance is launched.
DeleteOnTermination -> (boolean)
Whether to delete the volume when the instance is terminated.
Encrypted -> (boolean)
Whether to encrypt the volume.
Iops -> (integer)
The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
Only supported for
gp3orio1volumes. Required forio1volumes. Not used withstandard,gp2,st1, orsc1volumes.SnapshotId -> (string)
The snapshot ID of the volume to use.
You must specify either
VolumeSizeorSnapshotId.VolumeSize -> (integer)
The volume size, in GiBs. The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
You must specify either
SnapshotIdorVolumeSize. If you specify bothSnapshotIdandVolumeSize, the volume size must be equal or greater than the size of the snapshot.VolumeType -> (string)
The volume type.
NoDevice -> (boolean)
Whether to suppress the device that is included in the block device mapping of the Amazon Machine Image (AMI).
If
NoDeviceistrue, then you cannot specifyEbs.>VirtualName -> (string)
The name of the virtual device (for example,
ephemeral0).You can provide either
VirtualNameorEbs, but not both.ClassicLinkVpcId -> (string)
The identifier of a ClassicLink-enabled VPC that EC2-Classic instances are linked to.
ClassicLinkVpcSecurityGroups -> (list)
The identifiers of one or more security groups for the VPC that is specified in
ClassicLinkVPCId.(string)
CreatedTime -> (string)
The creation date and time for the launch configuration.
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.EbsOptimized -> (boolean)
Whether the launch configuration is optimized for Amazon EBS I/O.
IamInstanceProfile -> (string)
The name or the ARN of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
ImageId -> (string)
The identifier of the Amazon Machine Image (AMI) that is used to launch EC2 instances.
InstanceMonitoring -> (structure)
Indicates the type of monitoring for instances in the group.
Enabled -> (boolean)
If set to
true, then instances in the group launch with detailed monitoring.If set to
false, then instances in the group launch with basic monitoring.InstanceType -> (string)
The instance type for the instances.
KernelId -> (string)
The identifier of the kernel associated with the AMI.
KeyName -> (string)
The name of the key pair.
LaunchConfigurationName -> (string)
The name of the launch configuration.
PlacementTenancy -> (string)
The tenancy of the instance. An instance with
dedicatedtenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.RamdiskId -> (string)
The identifier of the RAM disk associated with the AMI.
SecurityGroups -> (list)
The security groups to assign to the instances in the Auto Scaling group.
(string)
SpotPrice -> (string)
The maximum hourly price to be paid for any Spot Instance that is launched to fulfill the request.
UserData -> (string)
The user data to make available to the launched EC2 instances. Must be base64-encoded text.
MetadataOptions -> (structure)
The metadata options for the instances.
HttpEndpoint -> (string)
Enables or disables the HTTP metadata endpoint on your instances. By default, the metadata endpoint is enabled.
HttpPutResponseHopLimit -> (integer)
The HTTP
PUTresponse hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.HttpTokens -> (string)
Indicates whether token usage is
requiredoroptionalfor metadata requests. By default, token usage isoptional.AwsEc2VpnConnection -> (structure)
Details about an EC2 VPN connection.
VpnConnectionId -> (string)
The identifier of the VPN connection.
State -> (string)
The current state of the VPN connection.
CustomerGatewayId -> (string)
The identifier of the customer gateway that is at your end of the VPN connection.
CustomerGatewayConfiguration -> (string)
The configuration information for the VPN connection’s customer gateway, in the native XML format.
Type -> (string)
The type of VPN connection.
VpnGatewayId -> (string)
The identifier of the virtual private gateway that is at the Amazon Web Services side of the VPN connection.
Category -> (string)
The category of the VPN connection.
VPNindicates an Amazon Web Services VPN connection.VPN-Classicindicates an Amazon Web Services Classic VPN connection.VgwTelemetry -> (list)
Information about the VPN tunnel.
(structure)
Information about the VPN tunnel.
AcceptedRouteCount -> (integer)
The number of accepted routes.
CertificateArn -> (string)
The ARN of the VPN tunnel endpoint certificate.
LastStatusChange -> (string)
The date and time of the last change in status.
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.OutsideIpAddress -> (string)
The Internet-routable IP address of the virtual private gateway’s outside interface.
Status -> (string)
The status of the VPN tunnel.
StatusMessage -> (string)
If an error occurs, a description of the error.
Options -> (structure)
The VPN connection options.
StaticRoutesOnly -> (boolean)
Whether the VPN connection uses static routes only.
TunnelOptions -> (list)
The VPN tunnel options.
(structure)
The VPN tunnel options.
DpdTimeoutSeconds -> (integer)
The number of seconds after which a Dead Peer Detection (DPD) timeout occurs.
IkeVersions -> (list)
The Internet Key Exchange (IKE) versions that are permitted for the VPN tunnel.
(string)
OutsideIpAddress -> (string)
The external IP address of the VPN tunnel.
Phase1DhGroupNumbers -> (list)
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
(integer)
Phase1EncryptionAlgorithms -> (list)
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
(string)
Phase1IntegrityAlgorithms -> (list)
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
(string)
Phase1LifetimeSeconds -> (integer)
The lifetime for phase 1 of the IKE negotiation, in seconds.
Phase2DhGroupNumbers -> (list)
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
(integer)
Phase2EncryptionAlgorithms -> (list)
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
(string)
Phase2IntegrityAlgorithms -> (list)
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
(string)
Phase2LifetimeSeconds -> (integer)
The lifetime for phase 2 of the IKE negotiation, in seconds.
PreSharedKey -> (string)
The preshared key to establish initial authentication between the virtual private gateway and the customer gateway.
RekeyFuzzPercentage -> (integer)
The percentage of the rekey window, which is determined by
RekeyMarginTimeSecondsduring which the rekey time is randomly selected.RekeyMarginTimeSeconds -> (integer)
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
ReplayWindowSize -> (integer)
The number of packets in an IKE replay window.
TunnelInsideCidr -> (string)
The range of inside IPv4 addresses for the tunnel.
Routes -> (list)
The static routes that are associated with the VPN connection.
(structure)
A static routes associated with the VPN connection.
DestinationCidrBlock -> (string)
The CIDR block associated with the local subnet of the customer data center.
State -> (string)
The current state of the static route.
TransitGatewayId -> (string)
The identifier of the transit gateway that is associated with the VPN connection.
AwsEcrContainerImage -> (structure)
Information about an Amazon ECR image.
RegistryId -> (string)
The Amazon Web Services account identifier that is associated with the registry that the image belongs to.
RepositoryName -> (string)
The name of the repository that the image belongs to.
Architecture -> (string)
The architecture of the image.
ImageDigest -> (string)
The sha256 digest of the image manifest.
ImageTags -> (list)
The list of tags that are associated with the image.
(string)
ImagePublishedAt -> (string)
The date and time when the image was pushed to the repository.
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.AwsOpenSearchServiceDomain -> (structure)
Details about an Amazon OpenSearch Service domain.
Arn -> (string)
The ARN of the OpenSearch Service domain.
AccessPolicies -> (string)
IAM policy document that specifies the access policies for the OpenSearch Service domain.
DomainName -> (string)
The name of the endpoint.
Id -> (string)
The identifier of the domain.
DomainEndpoint -> (string)
The domain endpoint.
EngineVersion -> (string)
The version of the domain engine.
EncryptionAtRestOptions -> (structure)
Details about the configuration for encryption at rest.
Enabled -> (boolean)
Whether encryption at rest is enabled.
KmsKeyId -> (string)
The KMS key ID.
NodeToNodeEncryptionOptions -> (structure)
Details about the configuration for node-to-node encryption.
Enabled -> (boolean)
Whether node-to-node encryption is enabled.
ServiceSoftwareOptions -> (structure)
Information about the status of a domain relative to the latest service software.
AutomatedUpdateDate -> (string)
The epoch time when the deployment window closes for required updates. After this time, OpenSearch Service schedules the software upgrade automatically.
Cancellable -> (boolean)
Whether a request to update the domain can be canceled.
CurrentVersion -> (string)
The version of the service software that is currently installed on the domain.
Description -> (string)
A more detailed description of the service software status.
NewVersion -> (string)
The most recent version of the service software.
UpdateAvailable -> (boolean)
Whether a service software update is available for the domain.
UpdateStatus -> (string)
The status of the service software update.
OptionalDeployment -> (boolean)
Whether the service software update is optional.
ClusterConfig -> (structure)
Details about the configuration of an OpenSearch cluster.
InstanceCount -> (integer)
The number of data nodes to use in the OpenSearch domain.
WarmEnabled -> (boolean)
Whether UltraWarm is enabled.
WarmCount -> (integer)
The number of UltraWarm instances.
DedicatedMasterEnabled -> (boolean)
Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.
ZoneAwarenessConfig -> (structure)
Configuration options for zone awareness. Provided if
ZoneAwarenessEnabledistrue.AvailabilityZoneCount -> (integer)
The number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.
DedicatedMasterCount -> (integer)
The number of instances to use for the master node. If this attribute is specified, then
DedicatedMasterEnabledmust betrue.InstanceType -> (string)
The instance type for your data nodes.
WarmType -> (string)
The type of UltraWarm instance.
ZoneAwarenessEnabled -> (boolean)
Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster’s nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
DedicatedMasterType -> (string)
The hardware configuration of the computer that hosts the dedicated master node.
If this attribute is specified, then
DedicatedMasterEnabledmust betrue.DomainEndpointOptions -> (structure)
Additional options for the domain endpoint.
CustomEndpointCertificateArn -> (string)
The ARN for the security certificate. The certificate is managed in ACM.
CustomEndpointEnabled -> (boolean)
Whether to enable a custom endpoint for the domain.
EnforceHTTPS -> (boolean)
Whether to require that all traffic to the domain arrive over HTTPS.
CustomEndpoint -> (string)
The fully qualified URL for the custom endpoint.
TLSSecurityPolicy -> (string)
The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain.
VpcOptions -> (structure)
Information that OpenSearch Service derives based on
VPCOptionsfor the domain.SecurityGroupIds -> (list)
The list of security group IDs that are associated with the VPC endpoints for the domain.
(string)
SubnetIds -> (list)
A list of subnet IDs that are associated with the VPC endpoints for the domain.
(string)
LogPublishingOptions -> (structure)
Configures the CloudWatch Logs to publish for the OpenSearch domain.
IndexSlowLogs -> (structure)
Configures the OpenSearch index logs publishing.
CloudWatchLogsLogGroupArn -> (string)
The ARN of the CloudWatch Logs group to publish the logs to.
Enabled -> (boolean)
Whether the log publishing is enabled.
SearchSlowLogs -> (structure)
Configures the OpenSearch search slow log publishing.
CloudWatchLogsLogGroupArn -> (string)
The ARN of the CloudWatch Logs group to publish the logs to.
Enabled -> (boolean)
Whether the log publishing is enabled.
AuditLogs -> (structure)
Configures the OpenSearch audit logs publishing.
CloudWatchLogsLogGroupArn -> (string)
The ARN of the CloudWatch Logs group to publish the logs to.
Enabled -> (boolean)
Whether the log publishing is enabled.
DomainEndpoints -> (map)
The domain endpoints. Used if the OpenSearch domain resides in a VPC.
This is a map of key-value pairs. The key is always
vpc. The value is the endpoint.key -> (string)
value -> (string)
AwsEc2VpcEndpointService -> (structure)
Details about the service configuration for a VPC endpoint service.
AcceptanceRequired -> (boolean)
Whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
AvailabilityZones -> (list)
The Availability Zones where the service is available.
(string)
BaseEndpointDnsNames -> (list)
The DNS names for the service.
(string)
ManagesVpcEndpoints -> (boolean)
Whether the service manages its VPC endpoints.
GatewayLoadBalancerArns -> (list)
The ARNs of the Gateway Load Balancers for the service.
(string)
NetworkLoadBalancerArns -> (list)
The ARNs of the Network Load Balancers for the service.
(string)
PrivateDnsName -> (string)
The private DNS name for the service.
ServiceId -> (string)
The identifier of the service.
ServiceName -> (string)
The name of the service.
ServiceState -> (string)
The current state of the service.
ServiceType -> (list)
The types for the service.
(structure)
The service type information for a VPC endpoint service.
ServiceType -> (string)
The type of service.
AwsXrayEncryptionConfig -> (structure)
Information about the encryption configuration for X-Ray.
KeyId -> (string)
The identifier of the KMS key that is used for encryption. Provided if
TypeisKMS.Status -> (string)
The current status of the encryption configuration. When
StatusisUPDATING, X-Ray might use both the old and new encryption.Type -> (string)
The type of encryption.
KMSindicates that the encryption uses KMS keys.NONEindicates to use the default encryption.AwsWafRateBasedRule -> (structure)
Details about a rate-based rule for global resources.
MetricName -> (string)
The name of the metrics for the rate-based rule.
Name -> (string)
The name of the rate-based rule.
RateKey -> (string)
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
RateLimit -> (long)
The maximum number of requests that have an identical value for the field specified in
RateKeythat are allowed within a five-minute period. If the number of requests exceedsRateLimitand the other predicates specified in the rule are met, WAF triggers the action for the rule.RuleId -> (string)
The unique identifier for the rate-based rule.
MatchPredicates -> (list)
The predicates to include in the rate-based rule.
(structure)
A match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.
DataId -> (string)
The unique identifier for the predicate.
Negated -> (boolean)
If set to
true, then the rule actions are performed on requests that match the predicate settings.If set to
false, then the rule actions are performed on all requests except those that match the predicate settings.Type -> (string)
The type of predicate.
AwsWafRegionalRateBasedRule -> (structure)
Details about a rate-based rule for Regional resources.
MetricName -> (string)
The name of the metrics for the rate-based rule.
Name -> (string)
The name of the rate-based rule.
RateKey -> (string)
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
RateLimit -> (long)
The maximum number of requests that have an identical value for the field specified in
RateKeythat are allowed within a five-minute period. If the number of requests exceedsRateLimitand the other predicates specified in the rule are met, WAF triggers the action for the rule.RuleId -> (string)
The unique identifier for the rate-based rule.
MatchPredicates -> (list)
The predicates to include in the rate-based rule.
(structure)
Details for a match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.
DataId -> (string)
The unique identifier for the predicate.
Negated -> (boolean)
If set to
true, then the rule actions are performed on requests that match the predicate settings.If set to
false, then the rule actions are performed on all requests except those that match the predicate settings.Type -> (string)
The type of predicate.
AwsEcrRepository -> (structure)
Information about an Amazon Elastic Container Registry repository.
Arn -> (string)
The ARN of the repository.
ImageScanningConfiguration -> (structure)
The image scanning configuration for a repository.
ScanOnPush -> (boolean)
Whether to scan images after they are pushed to a repository.
ImageTagMutability -> (string)
The tag mutability setting for the repository.
LifecyclePolicy -> (structure)
Information about the lifecycle policy for the repository.
LifecyclePolicyText -> (string)
The text of the lifecycle policy.
RegistryId -> (string)
The Amazon Web Services account identifier that is associated with the registry that contains the repository.
RepositoryName -> (string)
The name of the repository.
RepositoryPolicyText -> (string)
The text of the repository policy.
AwsEksCluster -> (structure)
Details about an Amazon EKS cluster.
Arn -> (string)
The ARN of the cluster.
CertificateAuthorityData -> (string)
The certificate authority data for the cluster.
ClusterStatus -> (string)
The status of the cluster.
Endpoint -> (string)
The endpoint for the Amazon EKS API server.
Name -> (string)
The name of the cluster.
ResourcesVpcConfig -> (structure)
The VPC configuration used by the cluster control plane.
SecurityGroupIds -> (list)
The security groups that are associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Amazon EKS control plane.
(string)
SubnetIds -> (list)
The subnets that are associated with the cluster.
(string)
RoleArn -> (string)
The ARN of the IAM role that provides permissions for the Amazon EKS control plane to make calls to Amazon Web Services API operations on your behalf.
Version -> (string)
The Amazon EKS server version for the cluster.
Logging -> (structure)
The logging configuration for the cluster.
ClusterLogging -> (list)
Cluster logging configurations.
(structure)
Details for a cluster logging configuration.
Enabled -> (boolean)
Whether the logging types that are listed in
Typesare enabled.Types -> (list)
A list of logging types.
(string)
AwsNetworkFirewallFirewallPolicy -> (structure)
Details about an Network Firewall firewall policy.
FirewallPolicy -> (structure)
The firewall policy configuration.
StatefulRuleGroupReferences -> (list)
The stateful rule groups that are used in the firewall policy.
(structure)
A stateful rule group that is used by the firewall policy.
ResourceArn -> (string)
The ARN of the stateful rule group.
StatelessCustomActions -> (list)
The custom action definitions that are available to use in the firewall policy’s
StatelessDefaultActionssetting.(structure)
A custom action that can be used for stateless packet handling.
ActionDefinition -> (structure)
The definition of the custom action.
PublishMetricAction -> (structure)
Information about metrics to publish to CloudWatch.
Dimensions -> (list)
Defines CloudWatch dimension values to publish.
(structure)
Defines a CloudWatch dimension value to publish.
Value -> (string)
The value to use for the custom metric dimension.
ActionName -> (string)
The name of the custom action.
StatelessDefaultActions -> (list)
The actions to take on a packet if it doesn’t match any of the stateless rules in the policy.
You must specify a standard action (
aws:pass,aws:drop,aws:forward_to_sfe), and can optionally include a custom action fromStatelessCustomActions.(string)
StatelessFragmentDefaultActions -> (list)
The actions to take on a fragmented UDP packet if it doesn’t match any of the stateless rules in the policy.
You must specify a standard action (
aws:pass,aws:drop,aws:forward_to_sfe), and can optionally include a custom action fromStatelessCustomActions.(string)
StatelessRuleGroupReferences -> (list)
The stateless rule groups that are used in the firewall policy.
(structure)
A stateless rule group that is used by the firewall policy.
Priority -> (integer)
The order in which to run the stateless rule group.
ResourceArn -> (string)
The ARN of the stateless rule group.
FirewallPolicyArn -> (string)
The ARN of the firewall policy.
FirewallPolicyId -> (string)
The identifier of the firewall policy.
FirewallPolicyName -> (string)
The name of the firewall policy.
Description -> (string)
A description of the firewall policy.
AwsNetworkFirewallFirewall -> (structure)
Details about an Network Firewall firewall.
DeleteProtection -> (boolean)
Whether the firewall is protected from deletion. If set to
true, then the firewall cannot be deleted.Description -> (string)
A description of the firewall.
FirewallArn -> (string)
The ARN of the firewall.
FirewallId -> (string)
The identifier of the firewall.
FirewallName -> (string)
A descriptive name of the firewall.
FirewallPolicyArn -> (string)
The ARN of the firewall policy.
FirewallPolicyChangeProtection -> (boolean)
Whether the firewall is protected from a change to the firewall policy. If set to
true, you cannot associate a different policy with the firewall.SubnetChangeProtection -> (boolean)
Whether the firewall is protected from a change to the subnet associations. If set to
true, you cannot map different subnets to the firewall.SubnetMappings -> (list)
The public subnets that Network Firewall uses for the firewall. Each subnet must belong to a different Availability Zone.
(structure)
A public subnet that Network Firewall uses for the firewall.
SubnetId -> (string)
The identifier of the subnet
VpcId -> (string)
The identifier of the VPC where the firewall is used.
AwsNetworkFirewallRuleGroup -> (structure)
Details about an Network Firewall rule group.
Capacity -> (integer)
The maximum number of operating resources that this rule group can use.
Description -> (string)
A description of the rule group.
RuleGroup -> (structure)
Details about the rule group.
RuleVariables -> (structure)
Additional settings to use in the specified rules.
IpSets -> (structure)
A list of IP addresses and address ranges, in CIDR notation.
Definition -> (list)
The list of IP addresses and ranges.
(string)
PortSets -> (structure)
A list of port ranges.
Definition -> (list)
The list of port ranges.
(string)
RulesSource -> (structure)
The rules and actions for the rule group.
For stateful rule groups, can contain
RulesString,RulesSourceList, orStatefulRules.For stateless rule groups, contains
StatelessRulesAndCustomActions.RulesSourceList -> (structure)
Stateful inspection criteria for a domain list rule group. A domain list rule group determines access by specific protocols to specific domains.
GeneratedRulesType -> (string)
Indicates whether to allow or deny access to the domains listed in
Targets.TargetTypes -> (list)
The protocols that you want to inspect. Specify
LS_SNIfor HTTPS. SpecifyHTTP_HOSTfor HTTP. You can specify either or both.(string)
Targets -> (list)
The domains that you want to inspect for in your traffic flows. You can provide full domain names, or use the ‘.’ prefix as a wildcard. For example,
.example.commatches all domains that end withexample.com.(string)
RulesString -> (string)
Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.
StatefulRules -> (list)
Suricata rule specifications.
(structure)
A Suricata rule specification.
Action -> (string)
Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
Header -> (structure)
The stateful inspection criteria for the rule.
Destination -> (string)
The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY.DestinationPort -> (string)
The destination port to inspect for. You can specify an individual port, such as
1994. You also can specify a port range, such as1990:1994. To match with any port, specifyANY.Direction -> (string)
The direction of traffic flow to inspect. If set to
ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set toFORWARD, the inspection only matches traffic going from the source to the destination.Protocol -> (string)
The protocol to inspect for. To inspector for all protocols, use
IP.Source -> (string)
The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY.SourcePort -> (string)
The source port to inspect for. You can specify an individual port, such as
1994. You also can specify a port range, such as1990:1994. To match with any port, specifyANY.RuleOptions -> (list)
Additional options for the rule.
(structure)
A rule option for a stateful rule.
Keyword -> (string)
A keyword to look for.
Settings -> (list)
A list of settings.
(string)
StatelessRulesAndCustomActions -> (structure)
The stateless rules and custom actions used by a stateless rule group.
CustomActions -> (list)
Custom actions for the rule group.
(structure)
A custom action definition. A custom action is an optional, non-standard action to use for stateless packet handling.
ActionDefinition -> (structure)
The definition of a custom action.
PublishMetricAction -> (structure)
Information about metrics to publish to CloudWatch.
Dimensions -> (list)
Defines CloudWatch dimension values to publish.
(structure)
Defines a CloudWatch dimension value to publish.
Value -> (string)
The value to use for the custom metric dimension.
ActionName -> (string)
A descriptive name of the custom action.
StatelessRules -> (list)
Stateless rules for the rule group.
(structure)
A stateless rule in the rule group.
Priority -> (integer)
Indicates the order in which to run this rule relative to all of the rules in the stateless rule group.
RuleDefinition -> (structure)
Provides the definition of the stateless rule.
Actions -> (list)
The actions to take on a packet that matches one of the stateless rule definition’s match attributes. You must specify a standard action (
aws:pass,aws:drop, oraws:forward_to_sfe). You can then add custom actions.(string)
MatchAttributes -> (structure)
The criteria for Network Firewall to use to inspect an individual packet in a stateless rule inspection.
DestinationPorts -> (list)
A list of port ranges to specify the destination ports to inspect for.
(structure)
A port range to specify the destination ports to inspect for.
FromPort -> (integer)
The starting port value for the port range.
ToPort -> (integer)
The ending port value for the port range.
Destinations -> (list)
The destination IP addresses and address ranges to inspect for, in CIDR notation.
(structure)
A destination IP address or range.
AddressDefinition -> (string)
An IP address or a block of IP addresses.
Protocols -> (list)
The protocols to inspect for.
(integer)
SourcePorts -> (list)
A list of port ranges to specify the source ports to inspect for.
(structure)
A port range to specify the source ports to inspect for.
FromPort -> (integer)
The starting port value for the port range.
ToPort -> (integer)
The ending port value for the port range.
Sources -> (list)
The source IP addresses and address ranges to inspect for, in CIDR notation.
(structure)
A source IP addresses and address range to inspect for.
AddressDefinition -> (string)
An IP address or a block of IP addresses.
TcpFlags -> (list)
The TCP flags and masks to inspect for.
(structure)
A set of TCP flags and masks to inspect for.
Flags -> (list)
Defines the flags from the
Maskssetting that must be set in order for the packet to match. Flags that are listed must be set. Flags that are not listed must not be set.(string)
Masks -> (list)
The set of flags to consider in the inspection. If not specified, then all flags are inspected.
(string)
RuleGroupArn -> (string)
The ARN of the rule group.
RuleGroupId -> (string)
The identifier of the rule group.
RuleGroupName -> (string)
The descriptive name of the rule group.
Type -> (string)
The type of rule group. A rule group can be stateful or stateless.
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 Amazon Web Services 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 Config evaluation wasNOT_APPLICABLE. If the 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 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 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 workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to
SUPPRESSEDorRESOLVEDdoes not prevent a new finding for the same issue.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- Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.
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.
PackageManager -> (string)
The source of the package.
FilePath -> (string)
The file system path to the package manager inventory file.
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.
Source -> (string)
The origin of the original CVSS score and vector.
Adjustments -> (list)
Adjustments to the CVSS metrics.
(structure)
An adjustment to the CVSS metric.
Metric -> (string)
The metric to adjust.
Reason -> (string)
The reason for the adjustment.
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 affects or that was taken on a resource.
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 Amazon Web Services 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.
FindingProviderFields -> (structure)
In a
BatchImportFindingsrequest, finding providers useFindingProviderFieldsto provide and update their own values for confidence, criticality, related findings, severity, and types.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.
RelatedFindings -> (list)
A list of findings that are related to the current finding.
(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.
Severity -> (structure)
The severity of a finding.
Label -> (string)
The severity label assigned to the finding by the finding provider.
Original -> (string)
The finding provider’s original value for the severity.
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)
Sample -> (boolean)
Indicates whether the finding is a sample finding.
JSON Syntax:
[
{
"SchemaVersion": "string",
"Id": "string",
"ProductArn": "string",
"ProductName": "string",
"CompanyName": "string",
"Region": "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"
...},
"DataClassification": {
"DetailedResultsLocation": "string",
"Result": {
"MimeType": "string",
"SizeClassified": long,
"AdditionalOccurrences": true|false,
"Status": {
"Code": "string",
"Reason": "string"
},
"SensitiveData": [
{
"Category": "string",
"Detections": [
{
"Count": long,
"Type": "string",
"Occurrences": {
"LineRanges": [
{
"Start": long,
"End": long,
"StartColumn": long
}
...
],
"OffsetRanges": [
{
"Start": long,
"End": long,
"StartColumn": long
}
...
],
"Pages": [
{
"PageNumber": long,
"LineRange": {
"Start": long,
"End": long,
"StartColumn": long
},
"OffsetRange": {
"Start": long,
"End": long,
"StartColumn": long
}
}
...
],
"Records": [
{
"JsonPath": "string",
"RecordIndex": long
}
...
],
"Cells": [
{
"Column": long,
"Row": long,
"ColumnName": "string",
"CellReference": "string"
}
...
]
}
}
...
],
"TotalCount": long
}
...
],
"CustomDataIdentifiers": {
"Detections": [
{
"Count": long,
"Arn": "string",
"Name": "string",
"Occurrences": {
"LineRanges": [
{
"Start": long,
"End": long,
"StartColumn": long
}
...
],
"OffsetRanges": [
{
"Start": long,
"End": long,
"StartColumn": long
}
...
],
"Pages": [
{
"PageNumber": long,
"LineRange": {
"Start": long,
"End": long,
"StartColumn": long
},
"OffsetRange": {
"Start": long,
"End": long,
"StartColumn": long
}
}
...
],
"Records": [
{
"JsonPath": "string",
"RecordIndex": long
}
...
],
"Cells": [
{
"Column": long,
"Row": long,
"ColumnName": "string",
"CellReference": "string"
}
...
]
}
}
...
],
"TotalCount": long
}
}
},
"Details": {
"AwsAutoScalingAutoScalingGroup": {
"LaunchConfigurationName": "string",
"LoadBalancerNames": ["string", ...],
"HealthCheckType": "string",
"HealthCheckGracePeriod": integer,
"CreatedTime": "string",
"MixedInstancesPolicy": {
"InstancesDistribution": {
"OnDemandAllocationStrategy": "string",
"OnDemandBaseCapacity": integer,
"OnDemandPercentageAboveBaseCapacity": integer,
"SpotAllocationStrategy": "string",
"SpotInstancePools": integer,
"SpotMaxPrice": "string"
},
"LaunchTemplate": {
"LaunchTemplateSpecification": {
"LaunchTemplateId": "string",
"LaunchTemplateName": "string",
"Version": "string"
},
"Overrides": [
{
"InstanceType": "string",
"WeightedCapacity": "string"
}
...
]
}
},
"AvailabilityZones": [
{
"Value": "string"
}
...
]
},
"AwsCodeBuildProject": {
"EncryptionKey": "string",
"Artifacts": [
{
"ArtifactIdentifier": "string",
"EncryptionDisabled": true|false,
"Location": "string",
"Name": "string",
"NamespaceType": "string",
"OverrideArtifactName": true|false,
"Packaging": "string",
"Path": "string",
"Type": "string"
}
...
],
"Environment": {
"Certificate": "string",
"EnvironmentVariables": [
{
"Name": "string",
"Type": "string",
"Value": "string"
}
...
],
"PrivilegedMode": true|false,
"ImagePullCredentialsType": "string",
"RegistryCredential": {
"Credential": "string",
"CredentialProvider": "string"
},
"Type": "string"
},
"Name": "string",
"Source": {
"Type": "string",
"Location": "string",
"GitCloneDepth": integer,
"InsecureSsl": true|false
},
"ServiceRole": "string",
"LogsConfig": {
"CloudWatchLogs": {
"GroupName": "string",
"Status": "string",
"StreamName": "string"
},
"S3Logs": {
"EncryptionDisabled": true|false,
"Location": "string",
"Status": "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
}
}
}
...
]
},
"ViewerCertificate": {
"AcmCertificateArn": "string",
"Certificate": "string",
"CertificateSource": "string",
"CloudFrontDefaultCertificate": true|false,
"IamCertificateId": "string",
"MinimumProtocolVersion": "string",
"SslSupportMethod": "string"
},
"Status": "string",
"WebAclId": "string"
},
"AwsEc2Instance": {
"Type": "string",
"ImageId": "string",
"IpV4Addresses": ["string", ...],
"IpV6Addresses": ["string", ...],
"KeyName": "string",
"IamInstanceProfileArn": "string",
"VpcId": "string",
"SubnetId": "string",
"LaunchedAt": "string",
"NetworkInterfaces": [
{
"NetworkInterfaceId": "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"
},
"AwsEc2Subnet": {
"AssignIpv6AddressOnCreation": true|false,
"AvailabilityZone": "string",
"AvailabilityZoneId": "string",
"AvailableIpAddressCount": integer,
"CidrBlock": "string",
"DefaultForAz": true|false,
"MapPublicIpOnLaunch": true|false,
"OwnerId": "string",
"State": "string",
"SubnetArn": "string",
"SubnetId": "string",
"VpcId": "string",
"Ipv6CidrBlockAssociationSet": [
{
"AssociationId": "string",
"Ipv6CidrBlock": "string",
"CidrBlockState": "string"
}
...
]
},
"AwsEc2NetworkAcl": {
"IsDefault": true|false,
"NetworkAclId": "string",
"OwnerId": "string",
"VpcId": "string",
"Associations": [
{
"NetworkAclAssociationId": "string",
"NetworkAclId": "string",
"SubnetId": "string"
}
...
],
"Entries": [
{
"CidrBlock": "string",
"Egress": true|false,
"IcmpTypeCode": {
"Code": integer,
"Type": integer
},
"Ipv6CidrBlock": "string",
"PortRange": {
"From": integer,
"To": integer
},
"Protocol": "string",
"RuleAction": "string",
"RuleNumber": integer
}
...
]
},
"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",
"LoadBalancerAttributes": [
{
"Key": "string",
"Value": "string"
}
...
]
},
"AwsElasticBeanstalkEnvironment": {
"ApplicationName": "string",
"Cname": "string",
"DateCreated": "string",
"DateUpdated": "string",
"Description": "string",
"EndpointUrl": "string",
"EnvironmentArn": "string",
"EnvironmentId": "string",
"EnvironmentLinks": [
{
"EnvironmentName": "string",
"LinkName": "string"
}
...
],
"EnvironmentName": "string",
"OptionSettings": [
{
"Namespace": "string",
"OptionName": "string",
"ResourceName": "string",
"Value": "string"
}
...
],
"PlatformArn": "string",
"SolutionStackName": "string",
"Status": "string",
"Tier": {
"Name": "string",
"Type": "string",
"Version": "string"
},
"VersionLabel": "string"
},
"AwsElasticsearchDomain": {
"AccessPolicies": "string",
"DomainEndpointOptions": {
"EnforceHTTPS": true|false,
"TLSSecurityPolicy": "string"
},
"DomainId": "string",
"DomainName": "string",
"Endpoint": "string",
"Endpoints": {"string": "string"
...},
"ElasticsearchVersion": "string",
"ElasticsearchClusterConfig": {
"DedicatedMasterCount": integer,
"DedicatedMasterEnabled": true|false,
"DedicatedMasterType": "string",
"InstanceCount": integer,
"InstanceType": "string",
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": integer
},
"ZoneAwarenessEnabled": true|false
},
"EncryptionAtRestOptions": {
"Enabled": true|false,
"KmsKeyId": "string"
},
"LogPublishingOptions": {
"IndexSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": true|false
},
"SearchSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": true|false
},
"AuditLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": true|false
}
},
"NodeToNodeEncryptionOptions": {
"Enabled": true|false
},
"ServiceSoftwareOptions": {
"AutomatedUpdateDate": "string",
"Cancellable": true|false,
"CurrentVersion": "string",
"Description": "string",
"NewVersion": "string",
"UpdateAvailable": true|false,
"UpdateStatus": "string"
},
"VPCOptions": {
"AvailabilityZones": ["string", ...],
"SecurityGroupIds": ["string", ...],
"SubnetIds": ["string", ...],
"VPCId": "string"
}
},
"AwsS3Bucket": {
"OwnerId": "string",
"OwnerName": "string",
"OwnerAccountId": "string",
"CreatedAt": "string",
"ServerSideEncryptionConfiguration": {
"Rules": [
{
"ApplyServerSideEncryptionByDefault": {
"SSEAlgorithm": "string",
"KMSMasterKeyID": "string"
}
}
...
]
},
"BucketLifecycleConfiguration": {
"Rules": [
{
"AbortIncompleteMultipartUpload": {
"DaysAfterInitiation": integer
},
"ExpirationDate": "string",
"ExpirationInDays": integer,
"ExpiredObjectDeleteMarker": true|false,
"Filter": {
"Predicate": {
"Operands": [
{
"Prefix": "string",
"Tag": {
"Key": "string",
"Value": "string"
},
"Type": "string"
}
...
],
"Prefix": "string",
"Tag": {
"Key": "string",
"Value": "string"
},
"Type": "string"
}
},
"ID": "string",
"NoncurrentVersionExpirationInDays": integer,
"NoncurrentVersionTransitions": [
{
"Days": integer,
"StorageClass": "string"
}
...
],
"Prefix": "string",
"Status": "string",
"Transitions": [
{
"Date": "string",
"Days": integer,
"StorageClass": "string"
}
...
]
}
...
]
},
"PublicAccessBlockConfiguration": {
"BlockPublicAcls": true|false,
"BlockPublicPolicy": true|false,
"IgnorePublicAcls": true|false,
"RestrictPublicBuckets": true|false
},
"AccessControlList": "string",
"BucketLoggingConfiguration": {
"DestinationBucketName": "string",
"LogFilePrefix": "string"
},
"BucketWebsiteConfiguration": {
"ErrorDocument": "string",
"IndexDocumentSuffix": "string",
"RedirectAllRequestsTo": {
"Hostname": "string",
"Protocol": "string"
},
"RoutingRules": [
{
"Condition": {
"HttpErrorCodeReturnedEquals": "string",
"KeyPrefixEquals": "string"
},
"Redirect": {
"Hostname": "string",
"HttpRedirectCode": "string",
"Protocol": "string",
"ReplaceKeyPrefixWith": "string",
"ReplaceKeyWith": "string"
}
}
...
]
},
"BucketNotificationConfiguration": {
"Configurations": [
{
"Events": ["string", ...],
"Filter": {
"S3KeyFilter": {
"FilterRules": [
{
"Name": "Prefix"|"Suffix",
"Value": "string"
}
...
]
}
},
"Destination": "string",
"Type": "string"
}
...
]
},
"BucketVersioningConfiguration": {
"IsMfaDeleteEnabled": true|false,
"Status": "string"
}
},
"AwsS3AccountPublicAccessBlock": {
"BlockPublicAcls": true|false,
"BlockPublicPolicy": true|false,
"IgnorePublicAcls": true|false,
"RestrictPublicBuckets": true|false
},
"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": {
"ClientCertificateId": "string",
"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",
"KeyRotationStatus": true|false
},
"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
},
"AwsEcsCluster": {
"CapacityProviders": ["string", ...],
"ClusterSettings": [
{
"Name": "string",
"Value": "string"
}
...
],
"Configuration": {
"ExecuteCommandConfiguration": {
"KmsKeyId": "string",
"LogConfiguration": {
"CloudWatchEncryptionEnabled": true|false,
"CloudWatchLogGroupName": "string",
"S3BucketName": "string",
"S3EncryptionEnabled": true|false,
"S3KeyPrefix": "string"
},
"Logging": "string"
}
},
"DefaultCapacityProviderStrategy": [
{
"Base": integer,
"CapacityProvider": "string",
"Weight": integer
}
...
]
},
"AwsEcsTaskDefinition": {
"ContainerDefinitions": [
{
"Command": ["string", ...],
"Cpu": integer,
"DependsOn": [
{
"Condition": "string",
"ContainerName": "string"
}
...
],
"DisableNetworking": true|false,
"DnsSearchDomains": ["string", ...],
"DnsServers": ["string", ...],
"DockerLabels": {"string": "string"
...},
"DockerSecurityOptions": ["string", ...],
"EntryPoint": ["string", ...],
"Environment": [
{
"Name": "string",
"Value": "string"
}
...
],
"EnvironmentFiles": [
{
"Type": "string",
"Value": "string"
}
...
],
"Essential": true|false,
"ExtraHosts": [
{
"Hostname": "string",
"IpAddress": "string"
}
...
],
"FirelensConfiguration": {
"Options": {"string": "string"
...},
"Type": "string"
},
"HealthCheck": {
"Command": ["string", ...],
"Interval": integer,
"Retries": integer,
"StartPeriod": integer,
"Timeout": integer
},
"Hostname": "string",
"Image": "string",
"Interactive": true|false,
"Links": ["string", ...],
"LinuxParameters": {
"Capabilities": {
"Add": ["string", ...],
"Drop": ["string", ...]
},
"Devices": [
{
"ContainerPath": "string",
"HostPath": "string",
"Permissions": ["string", ...]
}
...
],
"InitProcessEnabled": true|false,
"MaxSwap": integer,
"SharedMemorySize": integer,
"Swappiness": integer,
"Tmpfs": [
{
"ContainerPath": "string",
"MountOptions": ["string", ...],
"Size": integer
}
...
]
},
"LogConfiguration": {
"LogDriver": "string",
"Options": {"string": "string"
...},
"SecretOptions": [
{
"Name": "string",
"ValueFrom": "string"
}
...
]
},
"Memory": integer,
"MemoryReservation": integer,
"MountPoints": [
{
"ContainerPath": "string",
"ReadOnly": true|false,
"SourceVolume": "string"
}
...
],
"Name": "string",
"PortMappings": [
{
"ContainerPort": integer,
"HostPort": integer,
"Protocol": "string"
}
...
],
"Privileged": true|false,
"PseudoTerminal": true|false,
"ReadonlyRootFilesystem": true|false,
"RepositoryCredentials": {
"CredentialsParameter": "string"
},
"ResourceRequirements": [
{
"Type": "string",
"Value": "string"
}
...
],
"Secrets": [
{
"Name": "string",
"ValueFrom": "string"
}
...
],
"StartTimeout": integer,
"StopTimeout": integer,
"SystemControls": [
{
"Namespace": "string",
"Value": "string"
}
...
],
"Ulimits": [
{
"HardLimit": integer,
"Name": "string",
"SoftLimit": integer
}
...
],
"User": "string",
"VolumesFrom": [
{
"ReadOnly": true|false,
"SourceContainer": "string"
}
...
],
"WorkingDirectory": "string"
}
...
],
"Cpu": "string",
"ExecutionRoleArn": "string",
"Family": "string",
"InferenceAccelerators": [
{
"DeviceName": "string",
"DeviceType": "string"
}
...
],
"IpcMode": "string",
"Memory": "string",
"NetworkMode": "string",
"PidMode": "string",
"PlacementConstraints": [
{
"Expression": "string",
"Type": "string"
}
...
],
"ProxyConfiguration": {
"ContainerName": "string",
"ProxyConfigurationProperties": [
{
"Name": "string",
"Value": "string"
}
...
],
"Type": "string"
},
"RequiresCompatibilities": ["string", ...],
"TaskRoleArn": "string",
"Volumes": [
{
"DockerVolumeConfiguration": {
"Autoprovision": true|false,
"Driver": "string",
"DriverOpts": {"string": "string"
...},
"Labels": {"string": "string"
...},
"Scope": "string"
},
"EfsVolumeConfiguration": {
"AuthorizationConfig": {
"AccessPointId": "string",
"Iam": "string"
},
"FilesystemId": "string",
"RootDirectory": "string",
"TransitEncryption": "string",
"TransitEncryptionPort": integer
},
"Host": {
"SourcePath": "string"
},
"Name": "string"
}
...
]
},
"Container": {
"Name": "string",
"ImageId": "string",
"ImageName": "string",
"LaunchedAt": "string"
},
"Other": {"string": "string"
...},
"AwsRdsEventSubscription": {
"CustSubscriptionId": "string",
"CustomerAwsId": "string",
"Enabled": true|false,
"EventCategoriesList": ["string", ...],
"EventSubscriptionArn": "string",
"SnsTopicArn": "string",
"SourceIdsList": ["string", ...],
"SourceType": "string",
"Status": "string",
"SubscriptionCreationTime": "string"
},
"AwsEcsService": {
"CapacityProviderStrategy": [
{
"Base": integer,
"CapacityProvider": "string",
"Weight": integer
}
...
],
"Cluster": "string",
"DeploymentConfiguration": {
"DeploymentCircuitBreaker": {
"Enable": true|false,
"Rollback": true|false
},
"MaximumPercent": integer,
"MinimumHealthyPercent": integer
},
"DeploymentController": {
"Type": "string"
},
"DesiredCount": integer,
"EnableEcsManagedTags": true|false,
"EnableExecuteCommand": true|false,
"HealthCheckGracePeriodSeconds": integer,
"LaunchType": "string",
"LoadBalancers": [
{
"ContainerName": "string",
"ContainerPort": integer,
"LoadBalancerName": "string",
"TargetGroupArn": "string"
}
...
],
"Name": "string",
"NetworkConfiguration": {
"AwsVpcConfiguration": {
"AssignPublicIp": "string",
"SecurityGroups": ["string", ...],
"Subnets": ["string", ...]
}
},
"PlacementConstraints": [
{
"Expression": "string",
"Type": "string"
}
...
],
"PlacementStrategies": [
{
"Field": "string",
"Type": "string"
}
...
],
"PlatformVersion": "string",
"PropagateTags": "string",
"Role": "string",
"SchedulingStrategy": "string",
"ServiceArn": "string",
"ServiceName": "string",
"ServiceRegistries": [
{
"ContainerName": "string",
"ContainerPort": integer,
"Port": integer,
"RegistryArn": "string"
}
...
],
"TaskDefinition": "string"
},
"AwsAutoScalingLaunchConfiguration": {
"AssociatePublicIpAddress": true|false,
"BlockDeviceMappings": [
{
"DeviceName": "string",
"Ebs": {
"DeleteOnTermination": true|false,
"Encrypted": true|false,
"Iops": integer,
"SnapshotId": "string",
"VolumeSize": integer,
"VolumeType": "string"
},
"NoDevice": true|false,
"VirtualName": "string"
}
...
],
"ClassicLinkVpcId": "string",
"ClassicLinkVpcSecurityGroups": ["string", ...],
"CreatedTime": "string",
"EbsOptimized": true|false,
"IamInstanceProfile": "string",
"ImageId": "string",
"InstanceMonitoring": {
"Enabled": true|false
},
"InstanceType": "string",
"KernelId": "string",
"KeyName": "string",
"LaunchConfigurationName": "string",
"PlacementTenancy": "string",
"RamdiskId": "string",
"SecurityGroups": ["string", ...],
"SpotPrice": "string",
"UserData": "string",
"MetadataOptions": {
"HttpEndpoint": "string",
"HttpPutResponseHopLimit": integer,
"HttpTokens": "string"
}
},
"AwsEc2VpnConnection": {
"VpnConnectionId": "string",
"State": "string",
"CustomerGatewayId": "string",
"CustomerGatewayConfiguration": "string",
"Type": "string",
"VpnGatewayId": "string",
"Category": "string",
"VgwTelemetry": [
{
"AcceptedRouteCount": integer,
"CertificateArn": "string",
"LastStatusChange": "string",
"OutsideIpAddress": "string",
"Status": "string",
"StatusMessage": "string"
}
...
],
"Options": {
"StaticRoutesOnly": true|false,
"TunnelOptions": [
{
"DpdTimeoutSeconds": integer,
"IkeVersions": ["string", ...],
"OutsideIpAddress": "string",
"Phase1DhGroupNumbers": [integer, ...],
"Phase1EncryptionAlgorithms": ["string", ...],
"Phase1IntegrityAlgorithms": ["string", ...],
"Phase1LifetimeSeconds": integer,
"Phase2DhGroupNumbers": [integer, ...],
"Phase2EncryptionAlgorithms": ["string", ...],
"Phase2IntegrityAlgorithms": ["string", ...],
"Phase2LifetimeSeconds": integer,
"PreSharedKey": "string",
"RekeyFuzzPercentage": integer,
"RekeyMarginTimeSeconds": integer,
"ReplayWindowSize": integer,
"TunnelInsideCidr": "string"
}
...
]
},
"Routes": [
{
"DestinationCidrBlock": "string",
"State": "string"
}
...
],
"TransitGatewayId": "string"
},
"AwsEcrContainerImage": {
"RegistryId": "string",
"RepositoryName": "string",
"Architecture": "string",
"ImageDigest": "string",
"ImageTags": ["string", ...],
"ImagePublishedAt": "string"
},
"AwsOpenSearchServiceDomain": {
"Arn": "string",
"AccessPolicies": "string",
"DomainName": "string",
"Id": "string",
"DomainEndpoint": "string",
"EngineVersion": "string",
"EncryptionAtRestOptions": {
"Enabled": true|false,
"KmsKeyId": "string"
},
"NodeToNodeEncryptionOptions": {
"Enabled": true|false
},
"ServiceSoftwareOptions": {
"AutomatedUpdateDate": "string",
"Cancellable": true|false,
"CurrentVersion": "string",
"Description": "string",
"NewVersion": "string",
"UpdateAvailable": true|false,
"UpdateStatus": "string",
"OptionalDeployment": true|false
},
"ClusterConfig": {
"InstanceCount": integer,
"WarmEnabled": true|false,
"WarmCount": integer,
"DedicatedMasterEnabled": true|false,
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": integer
},
"DedicatedMasterCount": integer,
"InstanceType": "string",
"WarmType": "string",
"ZoneAwarenessEnabled": true|false,
"DedicatedMasterType": "string"
},
"DomainEndpointOptions": {
"CustomEndpointCertificateArn": "string",
"CustomEndpointEnabled": true|false,
"EnforceHTTPS": true|false,
"CustomEndpoint": "string",
"TLSSecurityPolicy": "string"
},
"VpcOptions": {
"SecurityGroupIds": ["string", ...],
"SubnetIds": ["string", ...]
},
"LogPublishingOptions": {
"IndexSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": true|false
},
"SearchSlowLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": true|false
},
"AuditLogs": {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": true|false
}
},
"DomainEndpoints": {"string": "string"
...}
},
"AwsEc2VpcEndpointService": {
"AcceptanceRequired": true|false,
"AvailabilityZones": ["string", ...],
"BaseEndpointDnsNames": ["string", ...],
"ManagesVpcEndpoints": true|false,
"GatewayLoadBalancerArns": ["string", ...],
"NetworkLoadBalancerArns": ["string", ...],
"PrivateDnsName": "string",
"ServiceId": "string",
"ServiceName": "string",
"ServiceState": "string",
"ServiceType": [
{
"ServiceType": "string"
}
...
]
},
"AwsXrayEncryptionConfig": {
"KeyId": "string",
"Status": "string",
"Type": "string"
},
"AwsWafRateBasedRule": {
"MetricName": "string",
"Name": "string",
"RateKey": "string",
"RateLimit": long,
"RuleId": "string",
"MatchPredicates": [
{
"DataId": "string",
"Negated": true|false,
"Type": "string"
}
...
]
},
"AwsWafRegionalRateBasedRule": {
"MetricName": "string",
"Name": "string",
"RateKey": "string",
"RateLimit": long,
"RuleId": "string",
"MatchPredicates": [
{
"DataId": "string",
"Negated": true|false,
"Type": "string"
}
...
]
},
"AwsEcrRepository": {
"Arn": "string",
"ImageScanningConfiguration": {
"ScanOnPush": true|false
},
"ImageTagMutability": "string",
"LifecyclePolicy": {
"LifecyclePolicyText": "string",
"RegistryId": "string"
},
"RepositoryName": "string",
"RepositoryPolicyText": "string"
},
"AwsEksCluster": {
"Arn": "string",
"CertificateAuthorityData": "string",
"ClusterStatus": "string",
"Endpoint": "string",
"Name": "string",
"ResourcesVpcConfig": {
"SecurityGroupIds": ["string", ...],
"SubnetIds": ["string", ...]
},
"RoleArn": "string",
"Version": "string",
"Logging": {
"ClusterLogging": [
{
"Enabled": true|false,
"Types": ["string", ...]
}
...
]
}
},
"AwsNetworkFirewallFirewallPolicy": {
"FirewallPolicy": {
"StatefulRuleGroupReferences": [
{
"ResourceArn": "string"
}
...
],
"StatelessCustomActions": [
{
"ActionDefinition": {
"PublishMetricAction": {
"Dimensions": [
{
"Value": "string"
}
...
]
}
},
"ActionName": "string"
}
...
],
"StatelessDefaultActions": ["string", ...],
"StatelessFragmentDefaultActions": ["string", ...],
"StatelessRuleGroupReferences": [
{
"Priority": integer,
"ResourceArn": "string"
}
...
]
},
"FirewallPolicyArn": "string",
"FirewallPolicyId": "string",
"FirewallPolicyName": "string",
"Description": "string"
},
"AwsNetworkFirewallFirewall": {
"DeleteProtection": true|false,
"Description": "string",
"FirewallArn": "string",
"FirewallId": "string",
"FirewallName": "string",
"FirewallPolicyArn": "string",
"FirewallPolicyChangeProtection": true|false,
"SubnetChangeProtection": true|false,
"SubnetMappings": [
{
"SubnetId": "string"
}
...
],
"VpcId": "string"
},
"AwsNetworkFirewallRuleGroup": {
"Capacity": integer,
"Description": "string",
"RuleGroup": {
"RuleVariables": {
"IpSets": {
"Definition": ["string", ...]
},
"PortSets": {
"Definition": ["string", ...]
}
},
"RulesSource": {
"RulesSourceList": {
"GeneratedRulesType": "string",
"TargetTypes": ["string", ...],
"Targets": ["string", ...]
},
"RulesString": "string",
"StatefulRules": [
{
"Action": "string",
"Header": {
"Destination": "string",
"DestinationPort": "string",
"Direction": "string",
"Protocol": "string",
"Source": "string",
"SourcePort": "string"
},
"RuleOptions": [
{
"Keyword": "string",
"Settings": ["string", ...]
}
...
]
}
...
],
"StatelessRulesAndCustomActions": {
"CustomActions": [
{
"ActionDefinition": {
"PublishMetricAction": {
"Dimensions": [
{
"Value": "string"
}
...
]
}
},
"ActionName": "string"
}
...
],
"StatelessRules": [
{
"Priority": integer,
"RuleDefinition": {
"Actions": ["string", ...],
"MatchAttributes": {
"DestinationPorts": [
{
"FromPort": integer,
"ToPort": integer
}
...
],
"Destinations": [
{
"AddressDefinition": "string"
}
...
],
"Protocols": [integer, ...],
"SourcePorts": [
{
"FromPort": integer,
"ToPort": integer
}
...
],
"Sources": [
{
"AddressDefinition": "string"
}
...
],
"TcpFlags": [
{
"Flags": ["string", ...],
"Masks": ["string", ...]
}
...
]
}
}
}
...
]
}
}
},
"RuleGroupArn": "string",
"RuleGroupId": "string",
"RuleGroupName": "string",
"Type": "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",
"PackageManager": "string",
"FilePath": "string"
}
...
],
"Cvss": [
{
"Version": "string",
"BaseScore": double,
"BaseVector": "string",
"Source": "string",
"Adjustments": [
{
"Metric": "string",
"Reason": "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
}
},
"FindingProviderFields": {
"Confidence": integer,
"Criticality": integer,
"RelatedFindings": [
{
"ProductArn": "string",
"Id": "string"
}
...
],
"Severity": {
"Label": "INFORMATIONAL"|"LOW"|"MEDIUM"|"HIGH"|"CRITICAL",
"Original": "string"
},
"Types": ["string", ...]
},
"Sample": 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",
"FindingProviderFields": {
"Severity": {
"Label": "LOW",
"Original": "10"
},
"Types": [
"Software and Configuration Checks/Vulnerabilities/CVE"
]
},
"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",
"Title": "CloudTrail trail vulnerability",
"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.