String code
String actionType
The type of action that was detected. The possible action types are:
NETWORK_CONNECTION
AWS_API_CALL
DNS_REQUEST
PORT_PROBE
NetworkConnectionAction networkConnectionAction
Included if ActionType is NETWORK_CONNECTION. Provides details about the network
connection that was detected.
AwsApiCallAction awsApiCallAction
Included if ActionType is AWS_API_CALL. Provides details about the API call that was
detected.
DnsRequestAction dnsRequestAction
Included if ActionType is DNS_REQUEST. Provides details about the DNS request that was
detected.
PortProbeAction portProbeAction
Included if ActionType is PORT_PROBE. Provides details about the port probe that was
detected.
String ipAddressV4
The IP address.
String ipAddressV4
The IP address.
IpOrganizationDetails organization
The internet service provider (ISP) organization associated with the remote IP address.
Country country
The country where the remote IP address is located.
City city
The city where the remote IP address is located.
GeoLocation geoLocation
The coordinates of the location of the remote IP address.
String api
The name of the API method that was issued.
String serviceName
The name of the Amazon Web Services service that the API method belongs to.
String callerType
Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (
domain).
ActionRemoteIpDetails remoteIpDetails
Provided if CallerType is remoteIp. Provides information about the remote IP address
that the API call originated from.
AwsApiCallActionDomainDetails domainDetails
Provided if CallerType is domain. Provides information about the DNS domain that the
API call originated from.
Map<K,V> affectedResources
Identifies the resources that were affected by the API call.
String firstSeen
An ISO8601-formatted timestamp that indicates when the API call was first observed.
String lastSeen
An ISO8601-formatted timestamp that indicates when the API call was most recently observed.
String domain
The name of the DNS domain that issued the API call.
Double percentTraffic
The percentage of traffic that is diverted to a canary deployment.
String deploymentId
The deployment identifier for the canary deployment.
Map<K,V> stageVariableOverrides
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.
Boolean useStageCache
Indicates whether the canary deployment uses the stage cache.
Boolean metricsEnabled
Indicates whether CloudWatch metrics are enabled for the method.
String loggingLevel
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 both ERROR events and extra
informational events.
Valid values: OFF | ERROR | INFO
Boolean dataTraceEnabled
Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.
Integer throttlingBurstLimit
The throttling burst limit for the method.
Double throttlingRateLimit
The throttling rate limit for the method.
Boolean cachingEnabled
Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.
Integer cacheTtlInSeconds
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.
Boolean cacheDataEncrypted
Indicates whether the cached responses are encrypted.
Boolean requireAuthorizationForCacheControl
Indicates whether authorization is required for a cache invalidation request.
String unauthorizedCacheControlHeaderStrategy
Indicates how to handle unauthorized requests for cache invalidation.
Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER |
SUCCEED_WITHOUT_RESPONSE_HEADER
String httpMethod
The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
String resourcePath
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/subresource must 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.
String id
The identifier of the REST API.
String name
The name of the REST API.
String description
A description of the REST API.
String createdDate
Indicates when the API was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String version
The version identifier for the REST API.
List<E> binaryMediaTypes
The list of binary media types supported by the REST API.
Integer minimumCompressionSize
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.
String apiKeySource
The source of the API key for metering requests according to a usage plan.
HEADER indicates whether to read the API key from the X-API-Key header of a request.
AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a
custom authorizer.
AwsApiGatewayEndpointConfiguration endpointConfiguration
The endpoint configuration of the REST API.
String deploymentId
The identifier of the deployment that the stage points to.
String clientCertificateId
The identifier of the client certificate for the stage.
String stageName
The name of the stage.
String description
A description of the stage.
Boolean cacheClusterEnabled
Indicates whether a cache cluster is enabled for the stage.
String cacheClusterSize
If a cache cluster is enabled, the size of the cache cluster.
String cacheClusterStatus
If a cache cluster is enabled, the status of the cache cluster.
List<E> methodSettings
Defines the method settings for the stage.
Map<K,V> variables
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 -._~:/?#&=,
String documentationVersion
The version of the API documentation that is associated with the stage.
AwsApiGatewayAccessLogSettings accessLogSettings
Settings for logging access for the stage.
AwsApiGatewayCanarySettings canarySettings
Information about settings for canary deployment in the stage.
Boolean tracingEnabled
Indicates whether active tracing with X-Ray is enabled for the stage.
String createdDate
Indicates when the stage was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String lastUpdatedDate
Indicates when the stage was most recently updated.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String webAclArn
The ARN of the web ACL associated with the stage.
String apiEndpoint
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.
String apiId
The identifier of the API.
String apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs.
String createdDate
Indicates when the API was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String description
A description of the API.
String version
The version identifier for the API.
String name
The name of the API.
String protocolType
The API protocol for the API.
Valid values: WEBSOCKET | HTTP
String routeSelectionExpression
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.
AwsCorsConfiguration corsConfiguration
A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
Boolean detailedMetricsEnabled
Indicates whether detailed metrics are enabled.
String loggingLevel
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 both ERROR events and extra
informational events.
Valid values: OFF | ERROR | INFO
Boolean dataTraceEnabled
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.
Integer throttlingBurstLimit
The throttling burst limit.
Double throttlingRateLimit
The throttling rate limit.
String clientCertificateId
The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
String createdDate
Indicates when the stage was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String description
The description of the stage.
AwsApiGatewayV2RouteSettings defaultRouteSettings
Default route settings for the stage.
String deploymentId
The identifier of the deployment that the stage is associated with.
String lastUpdatedDate
Indicates when the stage was most recently updated.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
AwsApiGatewayV2RouteSettings routeSettings
The route settings for the stage.
String stageName
The name of the stage.
Map<K,V> stageVariables
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 -._~:/?#&=,
AwsApiGatewayAccessLogSettings accessLogSettings
Information about settings for logging access for the stage.
Boolean autoDeploy
Indicates whether updates to an API automatically trigger a new deployment.
String lastDeploymentStatusMessage
The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
Boolean apiGatewayManaged
Indicates whether the stage is managed by API Gateway.
String launchConfigurationName
The name of the launch configuration.
List<E> loadBalancerNames
The list of load balancers associated with the group.
String healthCheckType
The service to use for the health checks.
Integer healthCheckGracePeriod
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.
String createdTime
Indicates when the auto scaling group was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String deviceName
The device name that is exposed to the EC2 instance. For example, /dev/sdh or xvdh.
AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails ebs
Parameters that are used to automatically set up Amazon EBS volumes when an instance is launched.
Boolean noDevice
Whether to suppress the device that is included in the block device mapping of the Amazon Machine Image (AMI).
If NoDevice is true, then you cannot specify Ebs.>
String virtualName
The name of the virtual device (for example, ephemeral0).
You can provide either VirtualName or Ebs, but not both.
Boolean deleteOnTermination
Whether to delete the volume when the instance is terminated.
Boolean encrypted
Whether to encrypt the volume.
Integer iops
The number of input/output (I/O) operations per second (IOPS) to provision for the volume.
Only supported for gp3 or io1 volumes. Required for io1 volumes. Not used
with standard, gp2, st1, or sc1 volumes.
String snapshotId
The snapshot ID of the volume to use.
You must specify either VolumeSize or SnapshotId.
Integer volumeSize
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 SnapshotId or VolumeSize. If you specify both
SnapshotId and VolumeSize, the volume size must be equal or greater than the size of
the snapshot.
String volumeType
The volume type.
Boolean associatePublicIpAddress
For Auto Scaling groups that run in a VPC, specifies whether to assign a public IP address to the group's instances.
List<E> blockDeviceMappings
Specifies the block devices for the instance.
String classicLinkVpcId
The identifier of a ClassicLink-enabled VPC that EC2-Classic instances are linked to.
List<E> classicLinkVpcSecurityGroups
The identifiers of one or more security groups for the VPC that is specified in ClassicLinkVPCId.
String createdTime
The creation date and time for the launch configuration.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Boolean ebsOptimized
Whether the launch configuration is optimized for Amazon EBS I/O.
String iamInstanceProfile
The name or the ARN of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
String imageId
The identifier of the Amazon Machine Image (AMI) that is used to launch EC2 instances.
AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails instanceMonitoring
Indicates the type of monitoring for instances in the group.
String instanceType
The instance type for the instances.
String kernelId
The identifier of the kernel associated with the AMI.
String keyName
The name of the key pair.
String launchConfigurationName
The name of the launch configuration.
String placementTenancy
The tenancy of the instance. An instance with dedicated tenancy runs on isolated, single-tenant
hardware and can only be launched into a VPC.
String ramdiskId
The identifier of the RAM disk associated with the AMI.
List<E> securityGroups
The security groups to assign to the instances in the Auto Scaling group.
String spotPrice
The maximum hourly price to be paid for any Spot Instance that is launched to fulfill the request.
String userData
The user data to make available to the launched EC2 instances. Must be base64-encoded text.
Boolean enabled
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.
String certificateAuthorityArn
The ARN of the private certificate authority (CA) that will be used to issue the certificate.
String createdAt
Indicates when the certificate was requested.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String domainName
The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.
List<E> domainValidationOptions
Contains information about the initial validation of each domain name that occurs as a result of the
RequestCertificate request.
Only provided if the certificate type is AMAZON_ISSUED.
List<E> extendedKeyUsages
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).
String failureReason
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 | OTHER
String importedAt
Indicates when the certificate was imported. Provided if the certificate type is IMPORTED.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
List<E> inUseBy
The list of ARNs for the Amazon Web Services resources that use the certificate.
String issuedAt
Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String issuer
The name of the certificate authority that issued and signed the certificate.
String keyAlgorithm
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_secp521r1
List<E> keyUsages
A list of key usage X.509 v3 extension objects.
String notAfter
The time after which the certificate becomes invalid.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String notBefore
The time before which the certificate is not valid.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
AwsCertificateManagerCertificateOptions options
Provides a value that specifies whether to add the certificate to a transparency log.
String renewalEligibility
Whether the certificate is eligible for renewal.
Valid values: ELIGIBLE | INELIGIBLE
AwsCertificateManagerCertificateRenewalSummary renewalSummary
Information about the status of the Certificate Manager managed renewal for the certificate. Provided only when
the certificate type is AMAZON_ISSUED.
String serial
The serial number of the certificate.
String signatureAlgorithm
The algorithm that was used to sign the certificate.
String status
The status of the certificate.
Valid values: PENDING_VALIDATION | ISSUED | INACTIVE |
EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED
String subject
The name of the entity that is associated with the public key contained in the certificate.
List<E> subjectAlternativeNames
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
The source of the certificate. For certificates that Certificate Manager provides, Type is
AMAZON_ISSUED. For certificates that are imported with ImportCertificate,
Type is IMPORTED.
Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE
String domainName
A fully qualified domain name (FQDN) in the certificate.
AwsCertificateManagerCertificateResourceRecord resourceRecord
The CNAME record that is added to the DNS database for domain validation.
String validationDomain
The domain name that Certificate Manager uses to send domain validation emails.
List<E> validationEmails
A list of email addresses that Certificate Manager uses to send domain validation emails.
String validationMethod
The method used to validate the domain name.
String validationStatus
The validation status of the domain name.
String name
The key usage extension name.
String certificateTransparencyLoggingPreference
Whether to add the certificate to a transparency log.
Valid values: DISABLED | ENABLED
List<E> domainValidationOptions
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.
String renewalStatus
The status of the Certificate Manager managed renewal of the certificate.
Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS |
FAILED
String renewalStatusReason
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 | OTHER
String updatedAt
Indicates when the renewal summary was last updated.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String viewerProtocolPolicy
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).
String viewerProtocolPolicy
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).
AwsCloudFrontDistributionCacheBehaviors cacheBehaviors
Provides information about the cache configuration for the distribution.
AwsCloudFrontDistributionDefaultCacheBehavior defaultCacheBehavior
The default cache behavior for the configuration.
String defaultRootObject
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).
String domainName
The domain name corresponding to the distribution.
String eTag
The entity tag is a hash of the object.
String lastModifiedTime
Indicates when that the distribution was last modified.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
AwsCloudFrontDistributionLogging logging
A complex type that controls whether access logs are written for the distribution.
AwsCloudFrontDistributionOrigins origins
A complex type that contains information about origins for this distribution.
AwsCloudFrontDistributionOriginGroups originGroups
Provides information about the origin groups in the distribution.
String status
Indicates the current status of the distribution.
String webAclId
A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution.
String bucket
The S3 bucket to store the access logs in.
Boolean enabled
With this field, you can enable or disable the selected distribution.
Boolean includeCookies
Specifies whether you want CloudFront to include cookies in access logs.
String prefix
An optional string that you want CloudFront to use as a prefix to the access log filenames for this distribution.
AwsCloudFrontDistributionOriginGroupFailover failoverCriteria
Provides the criteria for an origin group to fail over.
AwsCloudFrontDistributionOriginGroupFailoverStatusCodes statusCodes
Information about the status codes that cause an origin group to fail over.
String domainName
Amazon S3 origins: The DNS name of the S3 bucket from which you want CloudFront to get objects for this origin.
String id
A unique identifier for the origin or origin group.
String originPath
An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.
AwsCloudFrontDistributionOriginS3OriginConfig s3OriginConfig
An origin that is an S3 bucket that is not configured with static website hosting.
String originAccessIdentity
The CloudFront origin access identity to associate with the origin.
String cloudWatchLogsLogGroupArn
The ARN of the log group that CloudTrail logs are delivered to.
String cloudWatchLogsRoleArn
The ARN of the role that the CloudWatch Events endpoint assumes when it writes to the log group.
Boolean hasCustomEventSelectors
Indicates whether the trail has custom event selectors.
String homeRegion
The Region where the trail was created.
Boolean includeGlobalServiceEvents
Indicates whether the trail publishes events from global services such as IAM to the log files.
Boolean isMultiRegionTrail
Indicates whether the trail applies only to the current Region or to all Regions.
Boolean isOrganizationTrail
Whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account.
String kmsKeyId
The KMS key ID to use to encrypt the logs.
Boolean logFileValidationEnabled
Indicates whether CloudTrail log file validation is enabled.
String name
The name of the trail.
String s3BucketName
The name of the S3 bucket where the log files are published.
String s3KeyPrefix
The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log files are published.
String snsTopicArn
The ARN of the SNS topic that is used for notifications of log file delivery.
String snsTopicName
The name of the SNS topic that is used for notifications of log file delivery.
String trailArn
The ARN of the trail.
String encryptionKey
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).
AwsCodeBuildProjectEnvironment environment
Information about the build environment for this build project.
String name
The name of the build project.
AwsCodeBuildProjectSource source
Information about the build input source code for this build project.
String serviceRole
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.
AwsCodeBuildProjectVpcConfig vpcConfig
Information about the VPC configuration that CodeBuild accesses.
String certificate
The certificate to use with this build project.
String imagePullCredentialsType
The type of credentials CodeBuild uses to pull images in your build.
Valid values:
CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR
repository policy to trust the CodeBuild service principal.
SERVICE_ROLE specifies that CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When
you use an CodeBuild curated image, you must use CODEBUILD credentials.
AwsCodeBuildProjectEnvironmentRegistryCredential registryCredential
The credentials for access to a private registry.
String type
The type of build environment to use for related builds.
The environment type ARM_CONTAINER is 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_CONTAINER with 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_CONTAINER 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).
Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER |
ARM_CONTAINER
String credential
The ARN or name of credentials created using Secrets Manager.
The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.
String credentialProvider
The service that created the credentials to access a private Docker registry.
The valid value, SECRETS_MANAGER, is for Secrets Manager.
String type
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.
String location
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.
Integer gitCloneDepth
Information about the Git clone depth for the build project.
Boolean insecureSsl
Whether to ignore SSL warnings while connecting to the project source code.
List<E> allowOrigins
The allowed origins for CORS requests.
Boolean allowCredentials
Indicates whether the CORS request includes credentials.
List<E> exposeHeaders
The exposed headers for CORS requests.
Integer maxAge
The number of seconds for which the browser caches preflight request results.
List<E> allowMethods
The allowed methods for CORS requests.
List<E> allowHeaders
The allowed headers for CORS requests.
String billingMode
The method used to charge for read and write throughput and to manage capacity.
String lastUpdateToPayPerRequestDateTime
If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was set to that value.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
List<E> attributeDefinitions
A list of attribute definitions for the table.
AwsDynamoDbTableBillingModeSummary billingModeSummary
Information about the billing for read/write capacity on the table.
String creationDateTime
Indicates when the table was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
List<E> globalSecondaryIndexes
List of global secondary indexes for the table.
String globalTableVersion
The version of global tables being used.
Integer itemCount
The number of items in the table.
List<E> keySchema
The primary key structure for the table.
String latestStreamArn
The ARN of the latest stream for the table.
String latestStreamLabel
The label of the latest stream. The label is not a unique identifier.
List<E> localSecondaryIndexes
The list of local secondary indexes for the table.
AwsDynamoDbTableProvisionedThroughput provisionedThroughput
Information about the provisioned throughput for the table.
List<E> replicas
The list of replicas of this table.
AwsDynamoDbTableRestoreSummary restoreSummary
Information about the restore for the table.
AwsDynamoDbTableSseDescription sseDescription
Information about the server-side encryption for the table.
AwsDynamoDbTableStreamSpecification streamSpecification
The current DynamoDB Streams configuration for the table.
String tableId
The identifier of the table.
String tableName
The name of the table.
Long tableSizeBytes
The total size of the table in bytes.
String tableStatus
The current status of the table.
Boolean backfilling
Whether the index is currently backfilling.
String indexArn
The ARN of the index.
String indexName
The name of the index.
Long indexSizeBytes
The total size in bytes of the index.
String indexStatus
The current status of the index.
Integer itemCount
The number of items in the index.
List<E> keySchema
The key schema for the index.
AwsDynamoDbTableProjection projection
Attributes that are copied from the table into an index.
AwsDynamoDbTableProvisionedThroughput provisionedThroughput
Information about the provisioned throughput settings for the indexes.
String indexArn
The ARN of the index.
String indexName
The name of the index.
List<E> keySchema
The complete key schema for the index.
AwsDynamoDbTableProjection projection
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.
String lastDecreaseDateTime
Indicates when the provisioned throughput was last decreased.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String lastIncreaseDateTime
Indicates when the provisioned throughput was last increased.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Integer numberOfDecreasesToday
The number of times during the current UTC calendar day that the provisioned throughput was decreased.
Integer readCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException.
Integer writeCapacityUnits
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
Integer readCapacityUnits
The read capacity units for the replica.
List<E> globalSecondaryIndexes
List of global secondary indexes for the replica.
String kmsMasterKeyId
The identifier of the KMS key that will be used for KMS encryption for the replica.
AwsDynamoDbTableProvisionedThroughputOverride provisionedThroughputOverride
Replica-specific configuration for the provisioned throughput.
String regionName
The name of the Region where the replica is located.
String replicaStatus
The current status of the replica.
String replicaStatusDescription
Detailed information about the replica status.
String indexName
The name of the index.
AwsDynamoDbTableProvisionedThroughputOverride provisionedThroughputOverride
Replica-specific configuration for the provisioned throughput for the index.
String sourceBackupArn
The ARN of the source backup from which the table was restored.
String sourceTableArn
The ARN of the source table for the backup.
String restoreDateTime
Indicates the point in time that the table was restored to.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Boolean restoreInProgress
Whether a restore is currently in progress.
String inaccessibleEncryptionDateTime
If the key is inaccessible, the date and time when DynamoDB detected that the key was inaccessible.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String status
The status of the server-side encryption.
String sseType
The type of server-side encryption.
String kmsMasterKeyArn
The ARN of the KMS key that is used for the KMS encryption.
String instanceId
The identifier of the EC2 instance.
String publicIp
A public IP address that is associated with the EC2 instance.
String allocationId
The identifier that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with Amazon VPC.
String associationId
The identifier that represents the association of the Elastic IP address with an EC2 instance.
String domain
The domain in which to allocate the address.
If the address is for use with EC2 instances in a VPC, then Domain is vpc. Otherwise,
Domain is standard.
String publicIpv4Pool
The identifier of an IP address pool. This parameter allows Amazon EC2 to select an IP address from the address pool.
String networkBorderGroup
The name of the location from which the Elastic IP address is advertised.
String networkInterfaceId
The identifier of the network interface.
String networkInterfaceOwnerId
The Amazon Web Services account ID of the owner of the network interface.
String privateIpAddress
The private IP address that is associated with the Elastic IP address.
String type
The instance type of the instance.
String imageId
The Amazon Machine Image (AMI) ID of the instance.
List<E> ipV4Addresses
The IPv4 addresses associated with the instance.
List<E> ipV6Addresses
The IPv6 addresses associated with the instance.
String keyName
The key name associated with the instance.
String iamInstanceProfileArn
The IAM profile ARN of the instance.
String vpcId
The identifier of the VPC that the instance was launched in.
String subnetId
The identifier of the subnet that the instance was launched in.
String launchedAt
Indicates when the instance was launched.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
List<E> networkInterfaces
The identifiers of the network interfaces for the EC2 instance. The details for each network interface are in a
corresponding AwsEc2NetworkInterfacesDetails object.
String networkInterfaceId
The identifier of the network interface. The details are in a corresponding
AwsEc2NetworkInterfacesDetails object.
Boolean isDefault
Whether this is the default network ACL for the VPC.
String networkAclId
The identifier of the network ACL.
String ownerId
The identifier of the Amazon Web Services account that owns the network ACL.
String vpcId
The identifier of the VPC for the network ACL.
List<E> associations
Associations between the network ACL and subnets.
List<E> entries
The set of rules in the network ACL.
String cidrBlock
The IPV4 network range for which to deny or allow access.
Boolean egress
Whether the rule is an egress rule. An egress rule is a rule that applies to traffic that leaves the subnet.
IcmpTypeCode icmpTypeCode
The Internet Control Message Protocol (ICMP) type and code for which to deny or allow access.
String ipv6CidrBlock
The IPV6 network range for which to deny or allow access.
PortRangeFromTo portRange
For TCP or UDP protocols, the range of ports that the rule applies to.
String protocol
The protocol that the rule applies to. To deny or allow access to all protocols, use the value -1.
String ruleAction
Whether the rule is used to allow access or deny access.
Integer ruleNumber
The rule number. The rules are processed in order by their number.
String attachTime
Indicates when the attachment initiated.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String attachmentId
The identifier of the network interface attachment
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
Integer deviceIndex
The device index of the network interface attachment on the instance.
String instanceId
The ID of the instance.
String instanceOwnerId
The Amazon Web Services account ID of the owner of the instance.
String status
The attachment state.
Valid values: attaching | attached | detaching | detached
AwsEc2NetworkInterfaceAttachment attachment
The network interface attachment.
String networkInterfaceId
The ID of the network interface.
List<E> securityGroups
Security groups for the network interface.
Boolean sourceDestCheck
Indicates whether traffic to or from the instance is validated.
List<E> ipV6Addresses
The IPv6 addresses associated with the network interface.
List<E> privateIpAddresses
The private IPv4 addresses associated with the network interface.
String publicDnsName
The public DNS name of the network interface.
String publicIp
The address of the Elastic IP address bound to the network interface.
String ipV6Address
The IPV6 address.
String groupName
The name of the security group.
String groupId
The ID of the security group.
String ownerId
The Amazon Web Services account ID of the owner of the security group.
String vpcId
[VPC only] The ID of the VPC for the security group.
List<E> ipPermissions
The inbound rules associated with the security group.
List<E> ipPermissionsEgress
[VPC only] The outbound rules associated with the security group.
String ipProtocol
The IP protocol name (tcp, udp, icmp, icmpv6) or number.
[VPC only] Use -1 to specify all protocols.
When authorizing security group rules, specifying -1 or a protocol number other than tcp,
udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port
range you specify.
For tcp, udp, and icmp, 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.
Integer fromPort
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.
Integer toPort
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.
List<E> userIdGroupPairs
The security group and Amazon Web Services account ID pairs.
List<E> ipRanges
The IPv4 ranges.
List<E> ipv6Ranges
The IPv6 ranges.
List<E> prefixListIds
[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.
String cidrIp
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.
String cidrIpv6
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.
String prefixListId
The ID of the prefix.
String groupId
The ID of the security group.
String groupName
The name of the security group.
String peeringStatus
The status of a VPC peering connection, if applicable.
String userId
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.
String vpcId
The ID of the VPC for the referenced security group, if applicable.
String vpcPeeringConnectionId
The ID of the VPC peering connection, if applicable.
Boolean assignIpv6AddressOnCreation
Whether to assign an IPV6 address to a network interface that is created in this subnet.
String availabilityZone
The Availability Zone for the subnet.
String availabilityZoneId
The identifier of the Availability Zone for the subnet.
Integer availableIpAddressCount
The number of available IPV4 addresses in the subnet. Does not include addresses for stopped instances.
String cidrBlock
The IPV4 CIDR block that is assigned to the subnet.
Boolean defaultForAz
Whether this subnet is the default subnet for the Availability Zone.
Boolean mapPublicIpOnLaunch
Whether instances in this subnet receive a public IP address.
String ownerId
The identifier of the Amazon Web Services account that owns the subnet.
String state
The current state of the subnet.
String subnetArn
The ARN of the subnet.
String subnetId
The identifier of the subnet.
String vpcId
The identifier of the VPC that contains the subnet.
List<E> ipv6CidrBlockAssociationSet
The IPV6 CIDR blocks that are associated with the subnet.
String attachTime
The datetime when the attachment initiated.
Boolean deleteOnTermination
Whether the EBS volume is deleted when the EC2 instance is terminated.
String instanceId
The identifier of the EC2 instance.
String status
The attachment state of the volume.
String createTime
Indicates when the volume was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Boolean encrypted
Whether the volume is encrypted.
Integer size
The size of the volume, in GiBs.
String snapshotId
The snapshot from which the volume was created.
String status
The volume state.
String kmsKeyId
The ARN of the KMS key that was used to protect the volume encryption key for the volume.
List<E> attachments
The volume attachments.
List<E> cidrBlockAssociationSet
Information about the IPv4 CIDR blocks associated with the VPC.
List<E> ipv6CidrBlockAssociationSet
Information about the IPv6 CIDR blocks associated with the VPC.
String dhcpOptionsId
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.
String state
The current state of the VPC.
String vpnConnectionId
The identifier of the VPN connection.
String state
The current state of the VPN connection.
String customerGatewayId
The identifier of the customer gateway that is at your end of the VPN connection.
String customerGatewayConfiguration
The configuration information for the VPN connection's customer gateway, in the native XML format.
String type
The type of VPN connection.
String vpnGatewayId
The identifier of the virtual private gateway that is at the Amazon Web Services side of the VPN connection.
String category
The category of the VPN connection. VPN indicates an Amazon Web Services VPN connection.
VPN-Classic indicates an Amazon Web Services Classic VPN connection.
List<E> vgwTelemetry
Information about the VPN tunnel.
AwsEc2VpnConnectionOptionsDetails options
The VPN connection options.
List<E> routes
The static routes that are associated with the VPN connection.
String transitGatewayId
The identifier of the transit gateway that is associated with the VPN connection.
Integer dpdTimeoutSeconds
The number of seconds after which a Dead Peer Detection (DPD) timeout occurs.
List<E> ikeVersions
The Internet Key Exchange (IKE) versions that are permitted for the VPN tunnel.
String outsideIpAddress
The external IP address of the VPN tunnel.
List<E> phase1DhGroupNumbers
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
List<E> phase1EncryptionAlgorithms
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
List<E> phase1IntegrityAlgorithms
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
Integer phase1LifetimeSeconds
The lifetime for phase 1 of the IKE negotiation, in seconds.
List<E> phase2DhGroupNumbers
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
List<E> phase2EncryptionAlgorithms
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
List<E> phase2IntegrityAlgorithms
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
Integer phase2LifetimeSeconds
The lifetime for phase 2 of the IKE negotiation, in seconds.
String preSharedKey
The preshared key to establish initial authentication between the virtual private gateway and the customer gateway.
Integer rekeyFuzzPercentage
The percentage of the rekey window, which is determined by RekeyMarginTimeSeconds during which the
rekey time is randomly selected.
Integer rekeyMarginTimeSeconds
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.
Integer replayWindowSize
The number of packets in an IKE replay window.
String tunnelInsideCidr
The range of inside IPv4 addresses for the tunnel.
Integer acceptedRouteCount
The number of accepted routes.
String certificateArn
The ARN of the VPN tunnel endpoint certificate.
String lastStatusChange
The date and time of the last change in status.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String outsideIpAddress
The Internet-routable IP address of the virtual private gateway's outside interface.
String status
The status of the VPN tunnel.
String statusMessage
If an error occurs, a description of the error.
String registryId
The Amazon Web Services account identifier that is associated with the registry that the image belongs to.
String repositoryName
The name of the repository that the image belongs to.
String architecture
The architecture of the image.
String imageDigest
The sha256 digest of the image manifest.
List<E> imageTags
The list of tags that are associated with the image.
String imagePublishedAt
The date and time when the image was pushed to the repository.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
AwsEcsClusterConfigurationExecuteCommandConfigurationDetails executeCommandConfiguration
Contains the run command configuration for the cluster.
String kmsKeyId
The identifier of the KMS key that is used to encrypt the data between the local client and the container.
AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails logConfiguration
The log configuration for the results of the run command actions. Required if Logging is
NONE.
String logging
The log setting to use for redirecting logs for run command results.
Boolean cloudWatchEncryptionEnabled
Whether to enable encryption on the CloudWatch logs.
String cloudWatchLogGroupName
The name of the CloudWatch log group to send the logs to.
String s3BucketName
The name of the S3 bucket to send logs to.
Boolean s3EncryptionEnabled
Whether to encrypt the logs that are sent to the S3 bucket.
String s3KeyPrefix
Identifies the folder in the S3 bucket to send the logs to.
List<E> capacityProviders
The short name of one or more capacity providers to associate with the cluster.
List<E> clusterSettings
The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.
AwsEcsClusterConfigurationDetails configuration
The run command configuration for the cluster.
List<E> defaultCapacityProviderStrategy
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.
Integer base
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.
String capacityProvider
The short name of the capacity provider.
Integer weight
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.
Boolean enable
Whether to enable the deployment circuit breaker logic for the service.
Boolean rollback
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.
AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails deploymentCircuitBreaker
Determines whether a service deployment fails if a service cannot reach a steady state.
Integer maximumPercent
For a service that uses the rolling update (ECS) deployment type, the maximum number of tasks in a
service that are allowed in the RUNNING or PENDING state during a deployment, and for
tasks that use the EC2 launch type, when any container instances are in the DRAINING state. 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) or EXTERNAL deployment types, and
tasks that use the EC2 launch type, the maximum number of tasks in the service that remain in the
RUNNING state while the container instances are in the DRAINING state.
For the Fargate launch type, the maximum percent value is not used.
Integer minimumHealthyPercent
For a service that uses the rolling update (ECS) deployment type, the minimum number of tasks in a
service that must remain in the RUNNING state during a deployment, and while any container instances
are in the DRAINING state 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) or EXTERNAL deployment types and
tasks that use the EC2 launch type, the minimum number of the tasks in the service that remain in the
RUNNING state while the container instances are in the DRAINING state.
For the Fargate launch type, the minimum healthy percent value is not used.
String type
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 | EXTERNAL
List<E> capacityProviderStrategy
The capacity provider strategy that the service uses.
String cluster
The ARN of the cluster that hosts the service.
AwsEcsServiceDeploymentConfigurationDetails deploymentConfiguration
Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.
AwsEcsServiceDeploymentControllerDetails deploymentController
Contains the deployment controller type that the service uses.
Integer desiredCount
The number of instantiations of the task definition to run on the service.
Boolean enableEcsManagedTags
Whether to enable Amazon ECS managed tags for the tasks in the service.
Boolean enableExecuteCommand
Whether the execute command functionality is enabled for the service.
Integer healthCheckGracePeriodSeconds
After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.
String launchType
The launch type that the service uses.
Valid values: EC2 | FARGATE | EXTERNAL
List<E> loadBalancers
Information about the load balancers that the service uses.
String name
The name of the service.
AwsEcsServiceNetworkConfigurationDetails networkConfiguration
For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.
List<E> placementConstraints
The placement constraints for the tasks in the service.
List<E> placementStrategies
Information about how tasks for the service are placed.
String platformVersion
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 LATEST platform version is used by default.
String propagateTags
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 | SERVICE
String role
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.
String schedulingStrategy
The scheduling strategy to use for the service.
The REPLICA scheduling 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 DAEMON scheduling 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 | DAEMON
String serviceArn
The ARN of the service.
String serviceName
The name of the service.
The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.
List<E> serviceRegistries
Information about the service discovery registries to assign to the service.
String taskDefinition
The task definition to use for tasks in the service.
String containerName
The name of the container to associate with the load balancer.
Integer containerPort
The port on the container to associate with the load balancer. This port must correspond to a
containerPort in 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 the hostPort
of the port mapping.
String loadBalancerName
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.
String targetGroupArn
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.
String assignPublicIp
Whether the task's elastic network interface receives a public IP address. The default value is
DISABLED.
Valid values: ENABLED | DISABLED
List<E> securityGroups
The IDs of the security groups associated with the task or service.
You can provide up to five security groups.
List<E> subnets
The IDs of the subnets associated with the task or service.
You can provide up to 16 subnets.
AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails awsVpcConfiguration
The VPC subnet and security group configuration.
String expression
A cluster query language expression to apply to the constraint. You cannot specify an expression if the
constraint type is distinctInstance.
String type
The type of constraint. Use distinctInstance to run each task in a particular group on a different
container instance. Use memberOf to restrict the selection to a group of valid candidates.
Valid values: distinctInstance | memberOf
String field
The field to apply the placement strategy against.
For the spread placement strategy, valid values are instanceId (or host,
which has the same effect), or any platform or custom attribute that is applied to a container instance, such as
attribute:ecs.availability-zone.
For the binpack placement strategy, valid values are cpu and memory.
For the random placement strategy, this attribute is not used.
String type
The type of placement strategy.
The random placement strategy randomly places tasks on available candidates.
The spread placement strategy spreads placement across available candidates evenly based on the
value of Field.
The binpack strategy places tasks on available candidates that have the least available amount of
the resource that is specified in Field.
Valid values: random | spread | binpack
String containerName
The container name value to use for the service discovery service.
If the task definition uses the bridge or host network mode, you must specify
ContainerName and ContainerPort.
If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify
either ContainerName and ContainerPort, or Port , but not both.
Integer containerPort
The port value to use for the service discovery service.
If the task definition uses the bridge or host network mode, you must specify
ContainerName and ContainerPort.
If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify
either ContainerName and ContainerPort, or Port , but not both.
Integer port
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.
String registryArn
The ARN of the service registry.
List<E> command
The command that is passed to the container.
Integer cpu
The number of CPU units reserved for the container.
List<E> dependsOn
The dependencies that are defined for container startup and shutdown.
Boolean disableNetworking
Whether to disable networking within the container.
List<E> dnsSearchDomains
A list of DNS search domains that are presented to the container.
List<E> dnsServers
A list of DNS servers that are presented to the container.
Map<K,V> dockerLabels
A key-value map of labels to add to the container.
List<E> dockerSecurityOptions
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
List<E> entryPoint
The entry point that is passed to the container.
List<E> environment
The environment variables to pass to a container.
List<E> environmentFiles
A list of files containing the environment variables to pass to a container.
Boolean essential
Whether the container is essential. All tasks must have at least one essential container.
List<E> extraHosts
A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails firelensConfiguration
The FireLens configuration for the container. Specifies and configures a log router for container logs.
AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails healthCheck
The container health check command and associated configuration parameters for the container.
String hostname
The hostname to use for the container.
String image
The image used to start the container.
Boolean interactive
If set to true, then containerized applications can be deployed that require stdin or a
tty to be allocated.
List<E> links
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.
AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails linuxParameters
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails logConfiguration
The log configuration specification for the container.
Integer memory
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.
Integer memoryReservation
The soft limit (in MiB) of memory to reserve for the container.
List<E> mountPoints
The mount points for the data volumes in the container.
String name
The name of the container.
List<E> portMappings
The list of port mappings for the container.
Boolean privileged
Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.
Boolean pseudoTerminal
Whether to allocate a TTY to the container.
Boolean readonlyRootFilesystem
Whether the container is given read-only access to its root file system.
AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails repositoryCredentials
The private repository authentication credentials to use.
List<E> resourceRequirements
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
List<E> secrets
The secrets to pass to the container.
Integer startTimeout
The number of seconds to wait before giving up on resolving dependencies for a container.
Integer stopTimeout
The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.
List<E> systemControls
A list of namespaced kernel parameters to set in the container.
List<E> ulimits
A list of ulimits to set in the container.
String user
The user to use inside the container.
The value can use one of the following formats.
user
user : group
uid
uid : gid
user : gid
uid : group
List<E> volumesFrom
Data volumes to mount from another container.
String workingDirectory
The working directory in which to run commands inside the container.
Map<K,V> options
The options to use to configure the log router.
The valid option keys are as follows:
enable-ecs-log-metadata. The value can be true or false.
config-file-type. The value can be s3 or file.
config-file-value. The value is either an S3 ARN or a file path.
String type
The log router to use.
List<E> command
The command that the container runs to determine whether it is healthy.
Integer interval
The time period in seconds between each health check execution. The default value is 30 seconds.
Integer retries
The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.
Integer startPeriod
The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.
Integer timeout
The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.
AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails capabilities
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
List<E> devices
The host devices to expose to the container.
Boolean initProcessEnabled
Whether to run an init process inside the container that forwards signals and reaps processes.
Integer maxSwap
The total amount of swap memory (in MiB) that a container can use.
Integer sharedMemorySize
The value for the size (in MiB) of the /dev/shm volume.
Integer swappiness
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.
List<E> tmpfs
The container path, mount options, and size (in MiB) of the tmpfs mount.
String containerPath
The path inside the container at which to expose the host device.
String hostPath
The path for the device on the host container instance.
List<E> permissions
The explicit permissions to provide to the container for the device. By default, the container has permissions
for read, write, and mknod for the device.
String logDriver
The log driver to use for the container.
Map<K,V> options
The configuration options to send to the log driver. Requires version 1.19 of the Docker Remote API or greater on your container instance.
List<E> secretOptions
The secrets to pass to the log configuration.
String containerPath
The path on the container to mount the host volume at.
Boolean readOnly
Whether the container has read-only access to the volume.
String sourceVolume
The name of the volume to mount. Must match the name of a volume listed in VolumeDetails for the
task definition.
Integer containerPort
The port number on the container that is bound to the user-specified or automatically assigned host port.
Integer hostPort
The port number on the container instance to reserve for the container.
String protocol
The protocol used for the port mapping. The default is tcp.
String credentialsParameter
The ARN of the secret that contains the private repository credentials.
String type
The type of resource to assign to a container.
String value
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 the DeviceName attribute of an entry
in InferenceAccelerators.
List<E> containerDefinitions
The container definitions that describe the containers that make up the task.
String cpu
The number of CPU units used by the task.
String executionRoleArn
The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.
String family
The name of a family that this task definition is registered to.
List<E> inferenceAccelerators
The Elastic Inference accelerators to use for the containers in the task.
String ipcMode
The IPC resource namespace to use for the containers in the task.
String memory
The amount (in MiB) of memory used by the task.
String networkMode
The Docker networking mode to use for the containers in the task.
String pidMode
The process namespace to use for the containers in the task.
List<E> placementConstraints
The placement constraint objects to use for tasks.
AwsEcsTaskDefinitionProxyConfigurationDetails proxyConfiguration
The configuration details for the App Mesh proxy.
List<E> requiresCompatibilities
The task launch types that the task definition was validated against.
String taskRoleArn
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.
List<E> volumes
The data volume definitions for the task.
String containerName
The name of the container that will serve as the App Mesh proxy.
List<E> proxyConfigurationProperties
The set of network configuration parameters to provide to the Container Network Interface (CNI) plugin, specified as key-value pairs.
String type
The proxy type.
AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails dockerVolumeConfiguration
Information about a Docker volume.
AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails efsVolumeConfiguration
Information about the Amazon Elastic File System file system that is used for task storage.
AwsEcsTaskDefinitionVolumesHostDetails host
Information about a bind mount host volume.
String name
The name of the data volume.
Boolean autoprovision
Whether to create the Docker volume automatically if it does not already exist.
String driver
The Docker volume driver to use.
Map<K,V> driverOpts
A map of Docker driver-specific options that are passed through.
Map<K,V> labels
Custom metadata to add to the Docker volume.
String scope
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.
AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails authorizationConfig
The authorization configuration details for the Amazon EFS file system.
String filesystemId
The Amazon EFS file system identifier to use.
String rootDirectory
The directory within the Amazon EFS file system to mount as the root directory inside the host.
String transitEncryption
Whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
Integer transitEncryptionPort
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
String sourcePath
The path on the host container instance that is presented to the container.
String applicationName
The name of the application that is associated with the environment.
String cname
The URL to the CNAME for this environment.
String dateCreated
The creation date for this environment.
String dateUpdated
The date when this environment was last modified.
String description
A description of the environment.
String endpointUrl
For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.
String environmentArn
The ARN of the environment.
String environmentId
The identifier of the environment.
List<E> environmentLinks
Links to other environments in the same group.
String environmentName
The name of the environment.
List<E> optionSettings
The configuration setting for the environment.
String platformArn
The ARN of the platform version for the environment.
String solutionStackName
The name of the solution stack that is deployed with the environment.
String status
The current operational status of the environment.
AwsElasticBeanstalkEnvironmentTier tier
The tier of the environment.
String versionLabel
The application version of the environment.
String accessPolicies
IAM policy document specifying the access policies for the new Elasticsearch domain.
AwsElasticsearchDomainDomainEndpointOptions domainEndpointOptions
Additional options for the domain endpoint.
String domainId
Unique identifier for an Elasticsearch domain.
String domainName
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).
String endpoint
Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.
The endpoint is a service URL.
Map<K,V> endpoints
The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.
String elasticsearchVersion
Elasticsearch version.
AwsElasticsearchDomainElasticsearchClusterConfigDetails elasticsearchClusterConfig
Information about an Elasticsearch cluster configuration.
AwsElasticsearchDomainEncryptionAtRestOptions encryptionAtRestOptions
Details about the configuration for encryption at rest.
AwsElasticsearchDomainLogPublishingOptions logPublishingOptions
Configures the CloudWatch Logs to publish for the Elasticsearch domain.
AwsElasticsearchDomainNodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
Details about the configuration for node-to-node encryption.
AwsElasticsearchDomainServiceSoftwareOptions serviceSoftwareOptions
Information about the status of a domain relative to the latest service software.
AwsElasticsearchDomainVPCOptions vPCOptions
Information that Elasticsearch derives based on VPCOptions for the domain.
Boolean enforceHTTPS
Whether to require that all traffic to the domain arrive over HTTPS.
String tLSSecurityPolicy
The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch domain.
Valid values:
Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher
Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2
Integer dedicatedMasterCount
The number of instances to use for the master node. If this attribute is specified, then
DedicatedMasterEnabled must be true.
Boolean dedicatedMasterEnabled
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.
String dedicatedMasterType
The hardware configuration of the computer that hosts the dedicated master node. For example,
m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled
must be true.
Integer instanceCount
The number of data nodes to use in the Elasticsearch domain.
String instanceType
The instance type for your data nodes. For example, m3.medium.elasticsearch.
AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails zoneAwarenessConfig
Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.
Boolean zoneAwarenessEnabled
Whether to enable zone awareness for the Elasticsearch domain. When zone awareness is enabled, Elasticsearch 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.
Integer availabilityZoneCount
he number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.
AwsElasticsearchDomainLogPublishingOptionsLogConfig indexSlowLogs
Configures the Elasticsearch index logs publishing.
AwsElasticsearchDomainLogPublishingOptionsLogConfig searchSlowLogs
Configures the Elasticsearch search slow log publishing.
AwsElasticsearchDomainLogPublishingOptionsLogConfig auditLogs
Boolean enabled
Whether node-to-node encryption is enabled.
String automatedUpdateDate
The epoch time when the deployment window closes for required updates. After this time, Amazon Elasticsearch Service schedules the software upgrade automatically.
Boolean cancellable
Whether a request to update the domain can be canceled.
String currentVersion
The version of the service software that is currently installed on the domain.
String description
A more detailed description of the service software status.
String newVersion
The most recent version of the service software.
Boolean updateAvailable
Whether a service software update is available for the domain.
String updateStatus
The status of the service software update.
List<E> availabilityZones
The list of Availability Zones associated with the VPC subnets.
List<E> securityGroupIds
The list of security group IDs associated with the VPC endpoints for the domain.
List<E> subnetIds
A list of subnet IDs associated with the VPC endpoints for the domain.
String vPCId
ID for the VPC.
Long cookieExpirationPeriod
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.
String policyName
The name of the policy. The name must be unique within the set of policies for the load balancer.
Integer emitInterval
The interval in minutes for publishing the access logs.
You can publish access logs either every 5 minutes or every 60 minutes.
Boolean enabled
Indicates whether access logs are enabled for the load balancer.
String s3BucketName
The name of the S3 bucket where the access logs are stored.
String s3BucketPrefix
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.
AwsElbLoadBalancerAccessLog accessLog
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.
AwsElbLoadBalancerConnectionDraining connectionDraining
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.
AwsElbLoadBalancerConnectionSettings connectionSettings
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.
AwsElbLoadBalancerCrossZoneLoadBalancing crossZoneLoadBalancing
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.
Integer idleTimeout
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.
Boolean enabled
Indicates whether cross-zone load balancing is enabled for the load balancer.
List<E> availabilityZones
The list of Availability Zones for the load balancer.
List<E> backendServerDescriptions
Information about the configuration of the EC2 instances.
String canonicalHostedZoneName
The name of the Amazon Route 53 hosted zone for the load balancer.
String canonicalHostedZoneNameID
The ID of the Amazon Route 53 hosted zone for the load balancer.
String createdTime
Indicates when the load balancer was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String dnsName
The DNS name of the load balancer.
AwsElbLoadBalancerHealthCheck healthCheck
Information about the health checks that are conducted on the load balancer.
List<E> instances
List of EC2 instances for the load balancer.
List<E> listenerDescriptions
The policies that are enabled for the load balancer listeners.
AwsElbLoadBalancerAttributes loadBalancerAttributes
The attributes for a load balancer.
String loadBalancerName
The name of the load balancer.
AwsElbLoadBalancerPolicies policies
The policies for a load balancer.
String scheme
The type of load balancer. Only provided if the load balancer is in a VPC.
If Scheme is internet-facing, the load balancer has a public DNS name that resolves to
a public IP address.
If Scheme is internal, the load balancer has a public DNS name that resolves to a
private IP address.
List<E> securityGroups
The security groups for the load balancer. Only provided if the load balancer is in a VPC.
AwsElbLoadBalancerSourceSecurityGroup sourceSecurityGroup
Information about the security group for the load balancer. This is the security group that is used for inbound rules.
List<E> subnets
The list of subnet identifiers for the load balancer.
String vpcId
The identifier of the VPC for the load balancer.
Integer healthyThreshold
The number of consecutive health check successes required before the instance is moved to the Healthy state.
Integer interval
The approximate interval, in seconds, between health checks of an individual instance.
String target
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> .
Integer timeout
The amount of time, in seconds, during which no response means a failed health check.
Integer unhealthyThreshold
The number of consecutive health check failures that must occur before the instance is moved to the Unhealthy state.
String instanceId
The instance identifier.
Integer instancePort
The port on which the instance is listening.
String instanceProtocol
The protocol to use to route traffic to instances.
Valid values: HTTP | HTTPS | TCP | SSL
Integer loadBalancerPort
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.
String protocol
The load balancer transport protocol to use for routing.
Valid values: HTTP | HTTPS | TCP | SSL
String sslCertificateId
The ARN of the server certificate.
AwsElbLoadBalancerListener listener
Information about the listener.
List<E> policyNames
The policies enabled for the listener.
List<E> appCookieStickinessPolicies
The stickiness policies that are created using CreateAppCookieStickinessPolicy.
List<E> lbCookieStickinessPolicies
The stickiness policies that are created using CreateLBCookieStickinessPolicy.
List<E> otherPolicies
The policies other than the stickiness policies.
List<E> availabilityZones
The Availability Zones for the load balancer.
String canonicalHostedZoneId
The ID of the Amazon Route 53 hosted zone associated with the load balancer.
String createdTime
Indicates when the load balancer was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String dNSName
The public DNS name of the load balancer.
String ipAddressType
The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4
(for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
String scheme
The nodes of an Internet-facing load balancer have public IP addresses.
List<E> securityGroups
The IDs of the security groups for the load balancer.
LoadBalancerState state
The state of the load balancer.
String type
The type of load balancer.
String vpcId
The ID of the VPC for the load balancer.
String userName
The user associated with the IAM access key related to a finding.
The UserName parameter has been replaced with the PrincipalName parameter because
access keys can also be assigned to principals that are not IAM users.
String status
The status of the IAM access key related to a finding.
String createdAt
Indicates when the IAM access key was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String principalId
The ID of the principal associated with an access key.
String principalType
The type of principal associated with an access key.
String principalName
The name of the principal.
String accountId
The Amazon Web Services account ID of the account for the key.
String accessKeyId
The identifier of the access key.
AwsIamAccessKeySessionContext sessionContext
Information about the session that the key was used for.
AwsIamAccessKeySessionContextAttributes attributes
Attributes of the session that the key was used for.
AwsIamAccessKeySessionContextSessionIssuer sessionIssuer
Information about the entity that created the session.
Boolean mfaAuthenticated
Indicates whether the session used multi-factor authentication (MFA).
String creationDate
Indicates when the session was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String type
The type of principal (user, role, or group) that created the session.
String principalId
The principal ID of the principal (user, role, or group) that created the session.
String arn
The ARN of the session.
String accountId
The identifier of the Amazon Web Services account that created the session.
String userName
The name of the principal that created the session.
List<E> attachedManagedPolicies
A list of the managed policies that are attached to the IAM group.
String createDate
Indicates when the IAM group was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String groupId
The identifier of the IAM group.
String groupName
The name of the IAM group.
List<E> groupPolicyList
The list of inline policies that are embedded in the group.
String path
The path to the group.
String policyName
The name of the policy.
String arn
The ARN of the instance profile.
String createDate
Indicates when the instance profile was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String instanceProfileId
The identifier of the instance profile.
String instanceProfileName
The name of the instance profile.
String path
The path to the instance profile.
List<E> roles
The roles associated with the instance profile.
String arn
The ARN of the role.
String assumeRolePolicyDocument
The policy that grants an entity permission to assume the role.
String createDate
Indicates when the role was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String path
The path to the role.
String roleId
The identifier of the role.
String roleName
The name of the role.
Integer attachmentCount
The number of users, groups, and roles that the policy is attached to.
String createDate
When the policy was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String defaultVersionId
The identifier of the default version of the policy.
String description
A description of the policy.
Boolean isAttachable
Whether the policy can be attached to a user, group, or role.
String path
The path to the policy.
Integer permissionsBoundaryUsageCount
The number of users and roles that use the policy to set the permissions boundary.
String policyId
The unique identifier of the policy.
String policyName
The name of the policy.
List<E> policyVersionList
List of versions of the policy.
String updateDate
When the policy was most recently updated.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String versionId
The identifier of the policy version.
Boolean isDefaultVersion
Whether the version is the default version.
String createDate
Indicates when the version was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String assumeRolePolicyDocument
The trust policy that grants permission to assume the role.
List<E> attachedManagedPolicies
The list of the managed policies that are attached to the role.
String createDate
Indicates when the role was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
List<E> instanceProfileList
The list of instance profiles that contain this role.
AwsIamPermissionsBoundary permissionsBoundary
String roleId
The stable and unique string identifying the role.
String roleName
The friendly name that identifies the role.
List<E> rolePolicyList
The list of inline policies that are embedded in the role.
Integer maxSessionDuration
The maximum session duration (in seconds) that you want to set for the specified role.
String path
The path to the role.
String policyName
The name of the policy.
List<E> attachedManagedPolicies
A list of the managed policies that are attached to the user.
String createDate
Indicates when the user was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
List<E> groupList
A list of IAM groups that the user belongs to.
String path
The path to the user.
AwsIamPermissionsBoundary permissionsBoundary
The permissions boundary for the user.
String userId
The unique identifier for the user.
String userName
The name of the user.
List<E> userPolicyList
The list of inline policies that are embedded in the user.
String policyName
The name of the policy.
String aWSAccountId
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
Double creationDate
Indicates when the KMS key was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String keyId
The globally unique identifier for the KMS key.
String keyManager
The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.
String keyState
The state of the KMS key.
String origin
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.
String description
A description of the key.
Boolean keyRotationStatus
Whether the key has key rotation enabled.
String s3Bucket
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.
String s3Key
The Amazon S3 key of the deployment package.
String s3ObjectVersion
For versioned objects, the version of the deployment package object to use.
String zipFile
The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
String targetArn
The ARN of an SQS queue or SNS topic.
AwsLambdaFunctionCode code
An AwsLambdaFunctionCode object.
String codeSha256
The SHA256 hash of the function's deployment package.
AwsLambdaFunctionDeadLetterConfig deadLetterConfig
The function's dead letter queue.
AwsLambdaFunctionEnvironment environment
The function's environment variables.
String functionName
The name of the function.
String handler
The function that Lambda calls to begin executing your function.
String kmsKeyArn
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.
String lastModified
Indicates when the function was last updated.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
List<E> layers
The function's layers.
String masterArn
For Lambda@Edge functions, the ARN of the master function.
Integer memorySize
The memory that is allocated to the function.
String revisionId
The latest updated revision of the function or alias.
String role
The function's execution role.
String runtime
The runtime environment for the Lambda function.
Integer timeout
The amount of time that Lambda allows a function to run before stopping it.
AwsLambdaFunctionTracingConfig tracingConfig
The function's X-Ray tracing configuration.
AwsLambdaFunctionVpcConfig vpcConfig
The function's networking configuration.
String version
The version of the Lambda function.
Map<K,V> variables
Environment variable key-value pairs.
AwsLambdaFunctionEnvironmentError error
An AwsLambdaFunctionEnvironmentError object.
String mode
The tracing mode.
Long version
The version number.
List<E> compatibleRuntimes
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
Indicates when the version was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Integer allocatedStorage
For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).
List<E> availabilityZones
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
Integer backupRetentionPeriod
The number of days for which automated backups are retained.
String databaseName
The name of the database.
String status
The current status of this DB cluster.
String endpoint
The connection endpoint for the primary instance of the DB cluster.
String readerEndpoint
The reader endpoint for the DB cluster.
List<E> customEndpoints
A list of custom endpoints for the DB cluster.
Boolean multiAz
Whether the DB cluster has instances in multiple Availability Zones.
String engine
The name of the database engine to use for this DB cluster.
String engineVersion
The version number of the database engine to use.
Integer port
The port number on which the DB instances in the DB cluster accept connections.
String masterUsername
The name of the master user for the DB cluster.
String preferredBackupWindow
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.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Uses the format <day>:HH:MM-<day>:HH:MM.
For the day values, use mon|tue|wed|thu|fri|
sat|sun.
For example, sun:09:32-sun:10:02.
List<E> readReplicaIdentifiers
The identifiers of the read replicas that are associated with this DB cluster.
List<E> vpcSecurityGroups
A list of VPC security groups that the DB cluster belongs to.
String hostedZoneId
Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.
Boolean storageEncrypted
Whether the DB cluster is encrypted.
String kmsKeyId
The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.
String dbClusterResourceId
The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.
List<E> associatedRoles
A list of the IAM roles that are associated with the DB cluster.
String clusterCreateTime
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
List<E> enabledCloudWatchLogsExports
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
String engineMode
The database engine mode of the DB cluster.
Boolean deletionProtection
Whether the DB cluster has deletion protection enabled.
Boolean httpEndpointEnabled
Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
String activityStreamStatus
The status of the database activity stream.
Boolean copyTagsToSnapshot
Whether tags are copied from the DB cluster to snapshots of the DB cluster.
Boolean crossAccountClone
Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
List<E> domainMemberships
The Active Directory domain membership records that are associated with the DB cluster.
String dbClusterParameterGroup
The name of the DB cluster parameter group for the DB cluster.
String dbSubnetGroup
The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.
List<E> dbClusterOptionGroupMemberships
The list of option group memberships for this DB cluster.
String dbClusterIdentifier
The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.
List<E> dbClusterMembers
The list of instances that make up the DB cluster.
Boolean iamDatabaseAuthenticationEnabled
Whether the mapping of IAM accounts to database accounts is enabled.
Boolean isClusterWriter
Whether the cluster member is the primary instance for the DB cluster.
Integer promotionTier
Specifies the order in which an Aurora replica is promoted to the primary instance when the existing primary instance fails.
String dbInstanceIdentifier
The instance identifier for this member of the DB cluster.
String dbClusterParameterGroupStatus
The status of the DB cluster parameter group for this member of the DB cluster.
List<E> availabilityZones
A list of Availability Zones where instances in the DB cluster can be created.
String snapshotCreateTime
Indicates when the snapshot was taken.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String engine
The name of the database engine that you want to use for this DB instance.
Integer allocatedStorage
Specifies the allocated storage size in gibibytes (GiB).
String status
The status of this DB cluster snapshot.
Integer port
The port number on which the DB instances in the DB cluster accept connections.
String vpcId
The VPC ID that is associated with the DB cluster snapshot.
String clusterCreateTime
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String masterUsername
The name of the master user for the DB cluster.
String engineVersion
The version of the database engine to use.
String licenseModel
The license model information for this DB cluster snapshot.
String snapshotType
The type of DB cluster snapshot.
Integer percentProgress
Specifies the percentage of the estimated data that has been transferred.
Boolean storageEncrypted
Whether the DB cluster is encrypted.
String kmsKeyId
The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.
String dbClusterIdentifier
The DB cluster identifier.
String dbClusterSnapshotIdentifier
The identifier of the DB cluster snapshot.
Boolean iamDatabaseAuthenticationEnabled
Whether mapping of IAM accounts to database accounts is enabled.
String domain
The identifier of the Active Directory domain.
String status
The status of the Active Directory Domain membership for the DB instance.
String fqdn
The fully qualified domain name of the Active Directory domain.
String iamRoleName
The name of the IAM role to use when making API calls to the Directory Service.
String roleArn
The ARN of the IAM role that is associated with the DB instance.
String featureName
The name of the feature associated with the IAM role.
String status
Describes the state of the association between the IAM role and the DB instance. The Status property
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.
List<E> associatedRoles
The IAM roles associated with the DB instance.
String cACertificateIdentifier
The identifier of the CA certificate for this DB instance.
String dBClusterIdentifier
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.
String dBInstanceIdentifier
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
String dBInstanceClass
Contains the name of the compute and memory capacity class of the DB instance.
Integer dbInstancePort
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.
String dbiResourceId
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.
String dBName
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.
Boolean deletionProtection
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
AwsRdsDbInstanceEndpoint endpoint
Specifies the connection endpoint.
String engine
Provides the name of the database engine to use for this DB instance.
String engineVersion
Indicates the database engine version.
Boolean iAMDatabaseAuthenticationEnabled
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
String instanceCreateTime
Indicates when the DB instance was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String kmsKeyId
If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
Boolean publiclyAccessible
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.
Boolean storageEncrypted
Specifies whether the DB instance is encrypted.
String tdeCredentialArn
The ARN from the key store with which the instance is associated for TDE encryption.
List<E> vpcSecurityGroups
A list of VPC security groups that the DB instance belongs to.
Boolean multiAz
Whether the DB instance is a multiple Availability Zone deployment.
String enhancedMonitoringResourceArn
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
String dbInstanceStatus
The current status of the DB instance.
String masterUsername
The master user name of the DB instance.
Integer allocatedStorage
The amount of storage (in gigabytes) to initially allocate for the DB instance.
String preferredBackupWindow
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.
Integer backupRetentionPeriod
The number of days for which to retain automated backups.
List<E> dbSecurityGroups
A list of the DB security groups to assign to the DB instance.
List<E> dbParameterGroups
A list of the DB parameter groups to assign to the DB instance.
String availabilityZone
The Availability Zone where the DB instance will be created.
AwsRdsDbSubnetGroup dbSubnetGroup
Information about the subnet group that is associated with the DB instance.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Uses the format <day>:HH:MM-<day>:HH:MM.
For the day values, use mon|tue|wed|thu|fri|
sat|sun.
For example, sun:09:32-sun:10:02.
AwsRdsDbPendingModifiedValues pendingModifiedValues
Changes to the DB instance that are currently pending.
String latestRestorableTime
Specifies the latest time to which a database can be restored with point-in-time restore.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Boolean autoMinorVersionUpgrade
Indicates whether minor version patches are applied automatically.
String readReplicaSourceDBInstanceIdentifier
If this DB instance is a read replica, contains the identifier of the source DB instance.
List<E> readReplicaDBInstanceIdentifiers
List of identifiers of the read replicas associated with this DB instance.
List<E> readReplicaDBClusterIdentifiers
List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
String licenseModel
License model information for this DB instance.
Integer iops
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
List<E> optionGroupMemberships
The list of option group memberships for this DB instance.
String characterSetName
The name of the character set that this DB instance is associated with.
String secondaryAvailabilityZone
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
List<E> statusInfos
The status of a read replica. If the instance isn't a read replica, this is empty.
String storageType
The storage type for the DB instance.
List<E> domainMemberships
The Active Directory domain membership records associated with the DB instance.
Boolean copyTagsToSnapshot
Whether to copy resource tags to snapshots of the DB instance.
Integer monitoringInterval
The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
String monitoringRoleArn
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
Integer promotionTier
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
String timezone
The time zone of the DB instance.
Boolean performanceInsightsEnabled
Indicates whether Performance Insights is enabled for the DB instance.
String performanceInsightsKmsKeyId
The identifier of the KMS key used to encrypt the Performance Insights data.
Integer performanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
List<E> enabledCloudWatchLogsExports
A list of log types that this DB instance is configured to export to CloudWatch Logs.
List<E> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
AwsRdsDbInstanceEndpoint listenerEndpoint
Integer maxAllocatedStorage
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
String dbInstanceClass
The new DB instance class for the DB instance.
Integer allocatedStorage
The new value of the allocated storage for the DB instance.
String masterUserPassword
The new master user password for the DB instance.
Integer port
The new port for the DB instance.
Integer backupRetentionPeriod
The new backup retention period for the DB instance.
Boolean multiAZ
Indicates that a single Availability Zone DB instance is changing to a multiple Availability Zone deployment.
String engineVersion
The new engine version for the DB instance.
String licenseModel
The new license model value for the DB instance.
Integer iops
The new provisioned IOPS value for the DB instance.
String dbInstanceIdentifier
The new DB instance identifier for the DB instance.
String storageType
The new storage type for the DB instance.
String caCertificateIdentifier
The new CA certificate identifier for the DB instance.
String dbSubnetGroupName
The name of the new subnet group for the DB instance.
AwsRdsPendingCloudWatchLogsExports pendingCloudWatchLogsExports
A list of log types that are being enabled or disabled.
List<E> processorFeatures
Processor features that are being updated.
String dbSnapshotIdentifier
The name or ARN of the DB snapshot that is used to restore the DB instance.
String dbInstanceIdentifier
A name for the DB instance.
String snapshotCreateTime
When the snapshot was taken in Coordinated Universal Time (UTC).
String engine
The name of the database engine to use for this DB instance.
Integer allocatedStorage
The amount of storage (in gigabytes) to be initially allocated for the database instance.
String status
The status of this DB snapshot.
Integer port
The port that the database engine was listening on at the time of the snapshot.
String availabilityZone
Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.
String vpcId
The VPC ID associated with the DB snapshot.
String instanceCreateTime
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
String masterUsername
The master user name for the DB snapshot.
String engineVersion
The version of the database engine.
String licenseModel
License model information for the restored DB instance.
String snapshotType
The type of the DB snapshot.
Integer iops
The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
String optionGroupName
The option group name for the DB snapshot.
Integer percentProgress
The percentage of the estimated data that has been transferred.
String sourceRegion
The Amazon Web Services Region that the DB snapshot was created in or copied from.
String sourceDbSnapshotIdentifier
The DB snapshot ARN that the DB snapshot was copied from.
String storageType
The storage type associated with the DB snapshot.
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
Boolean encrypted
Whether the DB snapshot is encrypted.
String kmsKeyId
If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
String timezone
The time zone of the DB snapshot.
Boolean iamDatabaseAuthenticationEnabled
Whether mapping of IAM accounts to database accounts is enabled.
List<E> processorFeatures
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
String dbiResourceId
The identifier for the source DB instance.
String statusType
The type of status. For a read replica, the status type is read replication.
Boolean normal
Whether the read replica instance is operating normally.
String status
The status of the read replica instance.
String message
If the read replica is currently in an error state, provides the error details.
String dbSubnetGroupName
The name of the subnet group.
String dbSubnetGroupDescription
The description of the subnet group.
String vpcId
The VPC ID of the subnet group.
String subnetGroupStatus
The status of the subnet group.
List<E> subnets
A list of subnets in the subnet group.
String dbSubnetGroupArn
The ARN of the subnet group.
String subnetIdentifier
The identifier of a subnet in the subnet group.
AwsRdsDbSubnetGroupSubnetAvailabilityZone subnetAvailabilityZone
Information about the Availability Zone for a subnet in the subnet group.
String subnetStatus
The status of a subnet in the subnet group.
String name
The name of the Availability Zone for a subnet in the subnet group.
String custSubscriptionId
The identifier of the account that is associated with the event notification subscription.
String customerAwsId
The identifier of the event notification subscription.
Boolean enabled
Whether the event notification subscription is enabled.
List<E> eventCategoriesList
The list of event categories for the event notification subscription.
String eventSubscriptionArn
The ARN of the event notification subscription.
String snsTopicArn
The ARN of the SNS topic to post the event notifications to.
List<E> sourceIdsList
A list of source identifiers for the event notification subscription.
String sourceType
The source type for the event notification subscription.
String status
The status of the event notification subscription.
Valid values: creating | modifying | deleting | active |
no-permission | topic-not-exist
String subscriptionCreationTime
The datetime when the event notification subscription was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String parameterName
The name of the parameter.
String parameterApplyStatus
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-error
String parameterApplyErrorDescription
The error that prevented the parameter from being applied to the database.
String destinationRegion
The destination Region that snapshots are automatically copied to when cross-Region snapshot copy is enabled.
Integer manualSnapshotRetentionPeriod
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
Integer retentionPeriod
The number of days to retain automated snapshots in the destination Region after they are copied from a source Region.
String snapshotCopyGrantName
The name of the snapshot copy grant.
String deferMaintenanceEndTime
The end of the time window for which maintenance was deferred.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String deferMaintenanceIdentifier
The identifier of the maintenance window.
String deferMaintenanceStartTime
The start of the time window for which maintenance was deferred.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Boolean allowVersionUpgrade
Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.
Integer automatedSnapshotRetentionPeriod
The number of days that automatic cluster snapshots are retained.
String availabilityZone
The name of the Availability Zone in which the cluster is located.
String clusterAvailabilityStatus
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.
String clusterCreateTime
Indicates when the cluster was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String clusterIdentifier
The unique identifier of the cluster.
List<E> clusterNodes
The nodes in the cluster.
List<E> clusterParameterGroups
The list of cluster parameter groups that are associated with this cluster.
String clusterPublicKey
The public key for the cluster.
String clusterRevisionNumber
The specific revision number of the database in the cluster.
List<E> clusterSecurityGroups
A list of cluster security groups that are associated with the cluster.
AwsRedshiftClusterClusterSnapshotCopyStatus clusterSnapshotCopyStatus
Information about the destination Region and retention period for the cross-Region snapshot copy.
String clusterStatus
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-hsm
String clusterSubnetGroupName
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
String clusterVersion
The version ID of the Amazon Redshift engine that runs on the cluster.
String dBName
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 devdev is created by default.
List<E> deferredMaintenanceWindows
List of time windows during which maintenance was deferred.
AwsRedshiftClusterElasticIpStatus elasticIpStatus
Information about the status of the Elastic IP (EIP) address.
String elasticResizeNumberOfNodeOptions
The number of nodes that you can use the elastic resize method to resize the cluster to.
Boolean encrypted
Indicates whether the data in the cluster is encrypted at rest.
AwsRedshiftClusterEndpoint endpoint
The connection endpoint.
Boolean enhancedVpcRouting
Indicates whether to create the cluster with enhanced VPC routing enabled.
String expectedNextSnapshotScheduleTime
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-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String expectedNextSnapshotScheduleTimeStatus
The status of the next expected snapshot.
Valid values: OnTrack | Pending
AwsRedshiftClusterHsmStatus hsmStatus
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.
List<E> iamRoles
A list of IAM roles that the cluster can use to access other Amazon Web Services services.
String kmsKeyId
The identifier of the KMS encryption key that is used to encrypt data in the cluster.
String maintenanceTrackName
The name of the maintenance track for the cluster.
Integer manualSnapshotRetentionPeriod
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
String masterUsername
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.
String nextMaintenanceWindowStartTime
Indicates the start of the next maintenance window.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String nodeType
The node type for the nodes in the cluster.
Integer numberOfNodes
The number of compute nodes in the cluster.
List<E> pendingActions
A list of cluster operations that are waiting to start.
AwsRedshiftClusterPendingModifiedValues pendingModifiedValues
A list of changes to the cluster that are currently pending.
String preferredMaintenanceWindow
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 | sun
For example, sun:09:32-sun:10:02
Boolean publiclyAccessible
Whether the cluster can be accessed from a public network.
AwsRedshiftClusterResizeInfo resizeInfo
Information about the resize operation for the cluster.
AwsRedshiftClusterRestoreStatus restoreStatus
Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.
String snapshotScheduleIdentifier
A unique identifier for the cluster snapshot schedule.
String snapshotScheduleState
The current state of the cluster snapshot schedule.
Valid values: MODIFYING | ACTIVE | FAILED
String vpcId
The identifier of the VPC that the cluster is in, if the cluster is in a VPC.
List<E> vpcSecurityGroups
The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
String hsmClientCertificateIdentifier
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.
String hsmConfigurationIdentifier
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.
String status
Indicates whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Type: String
Valid values: active | applying
Integer automatedSnapshotRetentionPeriod
The pending or in-progress change to the automated snapshot retention period.
String clusterIdentifier
The pending or in-progress change to the identifier for the cluster.
String clusterType
The pending or in-progress change to the cluster type.
String clusterVersion
The pending or in-progress change to the service version.
String encryptionType
The encryption type for a cluster.
Boolean enhancedVpcRouting
Indicates whether to create the cluster with enhanced VPC routing enabled.
String maintenanceTrackName
The name of the maintenance track that the cluster changes to during the next maintenance window.
String masterUserPassword
The pending or in-progress change to the master user password for the cluster.
String nodeType
The pending or in-progress change to the cluster's node type.
Integer numberOfNodes
The pending or in-progress change to the number of nodes in the cluster.
Boolean publiclyAccessible
The pending or in-progress change to whether the cluster can be connected to from the public network.
Double currentRestoreRateInMegaBytesPerSecond
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.
Long elapsedTimeInSeconds
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.
Long estimatedTimeToCompletionInSeconds
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.
Long progressInMegaBytes
The number of megabytes that were transferred from snapshot storage.
This field is only updated when you restore to DC2 and DS2 node types.
Long snapshotSizeInMegaBytes
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.
String status
The status of the restore action.
Valid values: starting | restoring | completed | failed
Boolean blockPublicAcls
Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).
Boolean blockPublicPolicy
Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.
Boolean ignorePublicAcls
Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.
Boolean restrictPublicBuckets
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.
Integer daysAfterInitiation
The number of days after which Amazon S3 cancels an incomplete multipart upload.
AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails abortIncompleteMultipartUpload
How Amazon S3 responds when a multipart upload is incomplete. Specifically, provides a number of days before Amazon S3 cancels the entire upload.
String expirationDate
The date when objects are moved or deleted.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Integer expirationInDays
The length in days of the lifetime for objects that are subject to the rule.
Boolean expiredObjectDeleteMarker
Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to true, the
delete marker is expired. If set to false, the policy takes no action.
If you provide ExpiredObjectDeleteMarker, you cannot provide ExpirationInDays or
ExpirationDate.
AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails filter
Identifies the objects that a rule applies to.
String iD
The unique identifier of the rule.
Integer noncurrentVersionExpirationInDays
The number of days that an object is noncurrent before Amazon S3 can perform the associated action.
List<E> noncurrentVersionTransitions
Transition rules that describe when noncurrent objects transition to a specified storage class.
String prefix
A prefix that identifies one or more objects that the rule applies to.
String status
The current status of the rule. Indicates whether the rule is currently being applied.
List<E> transitions
Transition rules that indicate when objects transition to a specified storage class.
AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails predicate
The configuration for the filter.
List<E> operands
The values to use for the filter.
String prefix
A prefix filter.
AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails tag
A tag filter.
String type
Whether to use AND or OR to join the operands.
String prefix
Prefix text for matching objects.
AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails tag
A tag that is assigned to matching objects.
String type
The type of filter value.
String date
A date on which to transition objects to the specified storage class. If you provide Date, you
cannot provide Days.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Integer days
The number of days after which to transition the object to the specified storage class. If you provide
Days, you cannot provide Date.
String storageClass
The storage class to transition the object to.
String ownerId
The canonical user ID of the owner of the S3 bucket.
String ownerName
The display name of the owner of the S3 bucket.
String createdAt
Indicates when the S3 bucket was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
AwsS3BucketServerSideEncryptionConfiguration serverSideEncryptionConfiguration
The encryption rules that are applied to the S3 bucket.
AwsS3BucketBucketLifecycleConfigurationDetails bucketLifecycleConfiguration
The lifecycle configuration for objects in the S3 bucket.
AwsS3AccountPublicAccessBlockDetails publicAccessBlockConfiguration
Provides information about the Amazon S3 Public Access Block configuration for the S3 bucket.
String accessControlList
The access control list for the S3 bucket.
AwsS3BucketLoggingConfiguration bucketLoggingConfiguration
The logging configuration for the S3 bucket.
AwsS3BucketWebsiteConfiguration bucketWebsiteConfiguration
The website configuration parameters for the S3 bucket.
AwsS3BucketNotificationConfiguration bucketNotificationConfiguration
The notification configuration for the S3 bucket.
List<E> events
The list of events that trigger a notification.
AwsS3BucketNotificationConfigurationFilter filter
The filters that determine which S3 buckets generate notifications.
String destination
The ARN of the Lambda function, Amazon SQS queue, or Amazon SNS topic that generates the notification.
String type
Indicates the type of notification. Notifications can be generated using Lambda functions, Amazon SQS queues or Amazon SNS topics.
AwsS3BucketNotificationConfigurationS3KeyFilter s3KeyFilter
Details for an Amazon S3 filter.
AwsS3BucketServerSideEncryptionByDefault applyServerSideEncryptionByDefault
Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT object
request doesn't specify any server-side encryption, this default encryption is applied.
String errorDocument
The name of the error document for the website.
String indexDocumentSuffix
The name of the index document for the website.
AwsS3BucketWebsiteConfigurationRedirectTo redirectAllRequestsTo
The redirect behavior for requests to the website.
List<E> routingRules
The rules for applying redirects for requests to the website.
AwsS3BucketWebsiteConfigurationRoutingRuleCondition condition
Provides the condition that must be met in order to apply the routing rule.
AwsS3BucketWebsiteConfigurationRoutingRuleRedirect redirect
Provides the rules to redirect the request if the condition in Condition is met.
String hostname
The host name to use in the redirect request.
String httpRedirectCode
The HTTP redirect code to use in the response.
String protocol
The protocol to use to redirect the request. By default, uses the protocol from the original request.
String replaceKeyPrefixWith
The object key prefix to use in the redirect request.
Cannot be provided if ReplaceKeyWith is present.
String replaceKeyWith
The specific object key to use in the redirect request.
Cannot be provided if ReplaceKeyPrefixWith is present.
String lastModified
Indicates when the object was last modified.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String eTag
The opaque identifier assigned by a web server to a specific version of a resource found at a URL.
String versionId
The version of the object.
String contentType
A standard MIME type describing the format of the object data.
String serverSideEncryption
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.
String sSEKMSKeyId
The identifier of the KMS symmetric customer managed key that was used for the object.
AwsSecretsManagerSecretRotationRules rotationRules
Defines the rotation schedule for the secret.
Boolean rotationOccurredWithinFrequency
Whether the rotation occurred within the specified rotation frequency.
String kmsKeyId
The ARN, Key ID, or alias of the KMS key used to encrypt the SecretString or
SecretBinary values for versions of this secret.
Boolean rotationEnabled
Whether rotation is enabled.
String rotationLambdaArn
The ARN of the Lambda function that rotates the secret.
Boolean deleted
Whether the secret is deleted.
String name
The name of the secret.
String description
The user-provided description of the secret.
Integer automaticallyAfterDays
The number of days after the previous rotation to rotate the secret.
String schemaVersion
The schema version that a finding is formatted for.
String id
The security findings provider-specific identifier for a finding.
String productArn
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.
String productName
The name of the product that generated the finding.
Security Hub populates this attribute automatically for each finding. You cannot update it using
BatchImportFindings or BatchUpdateFindings. 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/ProductName attribute under ProductFields.
Security Hub does not synchronize those two attributes.
String companyName
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
BatchImportFindings or BatchUpdateFindings. 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/CompanyName attribute under ProductFields.
Security Hub does not synchronize those two attributes.
String region
The Region from which the finding was generated.
Security Hub populates this attribute automatically for each finding. You cannot update it using
BatchImportFindings or BatchUpdateFindings.
String generatorId
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.
String awsAccountId
The Amazon Web Services account ID that a finding is generated in.
List<E> types
One or more finding types in the format of namespace/category/classifier that classify a finding.
Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
String firstObservedAt
Indicates when the security-findings provider first observed the potential security issue that a finding captured.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String lastObservedAt
Indicates when the security-findings provider most recently observed the potential security issue that a finding captured.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String createdAt
Indicates when the security-findings provider created the potential security issue that a finding captured.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String updatedAt
Indicates when the security-findings provider last updated the finding record.
Uses the date-time format 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 severity
A finding's severity.
Integer confidence
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.
Integer criticality
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.
String title
A finding's title.
In this release, Title is a required property.
String description
A finding's description.
In this release, Description is a required property.
Remediation remediation
A data type that describes the remediation options for a finding.
String sourceUrl
A URL that links to a page about the current finding in the security-findings provider's solution.
Map<K,V> productFields
A data type where security-findings providers can include additional solution-specific details that aren't part
of the defined AwsSecurityFinding format.
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.
Map<K,V> userDefinedFields
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
List<E> malware
A list of malware related to a finding.
Network network
The details of network-related information about a finding.
List<E> networkPath
Provides information about a network path that is relevant to a finding. Each entry under
NetworkPath represents a component of that path.
ProcessDetails process
The details of process-related information about a finding.
List<E> threatIntelIndicators
Threat intelligence details related to a finding.
List<E> resources
A set of resource data types that describe the resources that the finding refers to.
Compliance compliance
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.
String verificationState
Indicates the veracity of a finding.
String workflowState
The workflow state of a finding.
Workflow workflow
Provides information about the status of the investigation into a finding.
String recordState
The record state of a finding.
List<E> relatedFindings
A list of related findings.
Note note
A user-defined note added to a finding.
List<E> vulnerabilities
Provides a list of vulnerabilities associated with the findings.
PatchSummary patchSummary
Provides an overview of the patch compliance status for an instance against a selected compliance standard.
Action action
Provides details about an action that affects or that was taken on a resource.
FindingProviderFields findingProviderFields
In a BatchImportFindings request, finding providers use FindingProviderFields to
provide and update their own values for confidence, criticality, related findings, severity, and types.
List<E> productArn
The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.
List<E> awsAccountId
The Amazon Web Services account ID that a finding is generated in.
List<E> id
The security findings provider-specific identifier for a finding.
List<E> generatorId
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.
List<E> region
The Region from which the finding was generated.
List<E> type
A finding type in the format of namespace/category/classifier that classifies a finding.
List<E> firstObservedAt
An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.
List<E> lastObservedAt
An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.
List<E> createdAt
An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.
List<E> updatedAt
An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.
List<E> severityProduct
The native severity as defined by the security-findings provider's solution that generated the finding.
List<E> severityNormalized
The normalized severity of a finding.
List<E> severityLabel
The label of a finding's severity.
List<E> confidence
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.
List<E> criticality
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.
List<E> title
A finding's title.
List<E> description
A finding's description.
List<E> recommendationText
The recommendation of what to do about the issue described in a finding.
List<E> sourceUrl
A URL that links to a page about the current finding in the security-findings provider's solution.
List<E> productFields
A data type where security-findings providers can include additional solution-specific details that aren't part
of the defined AwsSecurityFinding format.
List<E> productName
The name of the solution (product) that generates findings.
Note that this is a filter against the aws/securityhub/ProductName field in
ProductFields. It is not a filter for the top-level ProductName field.
List<E> companyName
The name of the findings provider (company) that owns the solution (product) that generates findings.
Note that this is a filter against the aws/securityhub/CompanyName field in
ProductFields. It is not a filter for the top-level CompanyName field.
List<E> userDefinedFields
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
List<E> malwareName
The name of the malware that was observed.
List<E> malwareType
The type of the malware that was observed.
List<E> malwarePath
The filesystem path of the malware that was observed.
List<E> malwareState
The state of the malware that was observed.
List<E> networkDirection
Indicates the direction of network traffic associated with a finding.
List<E> networkProtocol
The protocol of network-related information about a finding.
List<E> networkSourceIpV4
The source IPv4 address of network-related information about a finding.
List<E> networkSourceIpV6
The source IPv6 address of network-related information about a finding.
List<E> networkSourcePort
The source port of network-related information about a finding.
List<E> networkSourceDomain
The source domain of network-related information about a finding.
List<E> networkSourceMac
The source media access control (MAC) address of network-related information about a finding.
List<E> networkDestinationIpV4
The destination IPv4 address of network-related information about a finding.
List<E> networkDestinationIpV6
The destination IPv6 address of network-related information about a finding.
List<E> networkDestinationPort
The destination port of network-related information about a finding.
List<E> networkDestinationDomain
The destination domain of network-related information about a finding.
List<E> processName
The name of the process.
List<E> processPath
The path to the process executable.
List<E> processPid
The process ID.
List<E> processParentPid
The parent process ID.
List<E> processLaunchedAt
The date/time that the process was launched.
List<E> processTerminatedAt
The date/time that the process was terminated.
List<E> threatIntelIndicatorType
The type of a threat intelligence indicator.
List<E> threatIntelIndicatorValue
The value of a threat intelligence indicator.
List<E> threatIntelIndicatorCategory
The category of a threat intelligence indicator.
List<E> threatIntelIndicatorLastObservedAt
The date/time of the last observation of a threat intelligence indicator.
List<E> threatIntelIndicatorSource
The source of the threat intelligence.
List<E> threatIntelIndicatorSourceUrl
The URL for more details from the source of the threat intelligence.
List<E> resourceType
Specifies the type of the resource that details are provided for.
List<E> resourceId
The canonical identifier for the given resource type.
List<E> resourcePartition
The canonical Amazon Web Services partition name that the Region is assigned to.
List<E> resourceRegion
The canonical Amazon Web Services external Region name where this resource is located.
List<E> resourceTags
A list of Amazon Web Services tags associated with a resource at the time the finding was processed.
List<E> resourceAwsEc2InstanceType
The instance type of the instance.
List<E> resourceAwsEc2InstanceImageId
The Amazon Machine Image (AMI) ID of the instance.
List<E> resourceAwsEc2InstanceIpV4Addresses
The IPv4 addresses associated with the instance.
List<E> resourceAwsEc2InstanceIpV6Addresses
The IPv6 addresses associated with the instance.
List<E> resourceAwsEc2InstanceKeyName
The key name associated with the instance.
List<E> resourceAwsEc2InstanceIamInstanceProfileArn
The IAM profile ARN of the instance.
List<E> resourceAwsEc2InstanceVpcId
The identifier of the VPC that the instance was launched in.
List<E> resourceAwsEc2InstanceSubnetId
The identifier of the subnet that the instance was launched in.
List<E> resourceAwsEc2InstanceLaunchedAt
The date and time the instance was launched.
List<E> resourceAwsS3BucketOwnerId
The canonical user ID of the owner of the S3 bucket.
List<E> resourceAwsS3BucketOwnerName
The display name of the owner of the S3 bucket.
List<E> resourceAwsIamAccessKeyUserName
The user associated with the IAM access key related to a finding.
List<E> resourceAwsIamAccessKeyPrincipalName
The name of the principal that is associated with an IAM access key.
List<E> resourceAwsIamAccessKeyStatus
The status of the IAM access key related to a finding.
List<E> resourceAwsIamAccessKeyCreatedAt
The creation date/time of the IAM access key related to a finding.
List<E> resourceAwsIamUserUserName
The name of an IAM user.
List<E> resourceContainerName
The name of the container related to a finding.
List<E> resourceContainerImageId
The identifier of the image related to a finding.
List<E> resourceContainerImageName
The name of the image related to a finding.
List<E> resourceContainerLaunchedAt
The date/time that the container was started.
List<E> resourceDetailsOther
The details of a resource that doesn't have a specific subfield for the resource type defined.
List<E> complianceStatus
Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.
List<E> verificationState
The veracity of a finding.
List<E> workflowState
The workflow state of a finding.
Note that this field is deprecated. To search for a finding based on its workflow status, use
WorkflowStatus.
List<E> workflowStatus
The status of the investigation into a finding. Allowed values are the following.
NEW - The initial state of a finding, before it is reviewed.
Security Hub also resets the workflow status from NOTIFIED or RESOLVED to
NEW in the following cases:
The record state changes from ARCHIVED to ACTIVE.
The compliance status changes from PASSED to either WARNING, FAILED, or
NOT_AVAILABLE.
NOTIFIED - Indicates that the resource owner has been notified about the security issue. Used when
the initial reviewer is not the resource owner, and needs intervention from the resource owner.
SUPPRESSED - The finding will not be reviewed again and will not be acted upon.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
List<E> recordState
The updated record state for the finding.
List<E> relatedFindingsProductArn
The ARN of the solution that generated a related finding.
List<E> relatedFindingsId
The solution-generated identifier for a related finding.
List<E> noteText
The text of a note.
List<E> noteUpdatedAt
The timestamp of when the note was updated.
List<E> noteUpdatedBy
The principal that created a note.
List<E> keyword
A keyword for a finding.
List<E> findingProviderFieldsConfidence
The finding provider value for the finding 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.
List<E> findingProviderFieldsCriticality
The finding provider value for the level of importance assigned to the resources associated with the findings.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
List<E> findingProviderFieldsRelatedFindingsId
The finding identifier of a related finding that is identified by the finding provider.
List<E> findingProviderFieldsRelatedFindingsProductArn
The ARN of the solution that generated a related finding that is identified by the finding provider.
List<E> findingProviderFieldsSeverityLabel
The finding provider value for the severity label.
List<E> findingProviderFieldsSeverityOriginal
The finding provider's original value for the severity.
List<E> findingProviderFieldsTypes
One or more finding types that the finding provider assigned to the finding. Uses the format of
namespace/category/classifier that classify a finding.
Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
String id
The identifier of the finding that was specified by the finding provider.
String productArn
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.
String kmsMasterKeyId
The ID of an Amazon Web Services managed key for Amazon SNS or a customer managed key.
List<E> subscription
Subscription is an embedded property that describes the subscription endpoints of an SNS topic.
String topicName
The name of the topic.
String owner
The subscription's owner.
Integer kmsDataKeyReusePeriodSeconds
The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.
String kmsMasterKeyId
The ID of an Amazon Web Services managed key for Amazon SQS or a custom KMS key.
String queueName
The name of the new queue.
String deadLetterTargetArn
The ARN of the dead-letter queue to which Amazon SQS moves messages after the value of
maxReceiveCount is exceeded.
String status
The current patch compliance status.
The possible status values are:
COMPLIANT
NON_COMPLIANT
UNSPECIFIED_DATA
Integer compliantCriticalCount
For the patches that are compliant, the number that have a severity of CRITICAL.
Integer compliantHighCount
For the patches that are compliant, the number that have a severity of HIGH.
Integer compliantMediumCount
For the patches that are compliant, the number that have a severity of MEDIUM.
String executionType
The type of execution that was used determine compliance.
Integer nonCompliantCriticalCount
For the patch items that are noncompliant, the number of items that have a severity of CRITICAL.
Integer compliantInformationalCount
For the patches that are compliant, the number that have a severity of INFORMATIONAL.
Integer nonCompliantInformationalCount
For the patches that are noncompliant, the number that have a severity of INFORMATIONAL.
Integer compliantUnspecifiedCount
For the patches that are compliant, the number that have a severity of UNSPECIFIED.
Integer nonCompliantLowCount
For the patches that are noncompliant, the number that have a severity of LOW.
Integer nonCompliantHighCount
For the patches that are noncompliant, the number that have a severity of HIGH.
Integer compliantLowCount
For the patches that are compliant, the number that have a severity of LOW.
String complianceType
The type of resource for which the compliance was determined. For AwsSsmPatchCompliance,
ComplianceType is Patch.
String patchBaselineId
The identifier of the patch baseline. The patch baseline lists the patches that are approved for installation.
String overallSeverity
The highest severity for the patches.
Integer nonCompliantMediumCount
For the patches that are noncompliant, the number that have a severity of MEDIUM.
Integer nonCompliantUnspecifiedCount
For the patches that are noncompliant, the number that have a severity of UNSPECIFIED.
String patchGroup
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.
AwsSsmComplianceSummary complianceSummary
The compliance status details for the patch.
AwsSsmPatch patch
Information about the status of a patch.
String name
A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
String defaultAction
The action to perform if none of the rules contained in the WebACL match.
List<E> rules
An array that contains the action for each rule in a WebACL, the priority of the rule, and the ID of the rule.
String webAclId
A unique identifier for a WebACL.
WafAction action
Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
List<E> excludedRules
Rules to exclude from a rule group.
WafOverrideAction overrideAction
Use the OverrideAction to test your RuleGroup.
Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to
None, 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 OverrideAction to Count. The
RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of
blocking matching requests, those requests are counted.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a
WebACL. In this case you do not use ActivatedRule|Action. For all other update
requests, ActivatedRule|Action is used instead of ActivatedRule|
OverrideAction.
Integer priority
Specifies the order in which the rules in a WebACL are evaluated. Rules with a lower value for
Priority are 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.
String ruleId
The identifier for a rule.
String type
The rule type.
Valid values: REGULAR | RATE_BASED | GROUP
The default is REGULAR.
List<E> findings
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.
List<E> findingIdentifiers
The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a
time.
For each finding, the list provides the finding identifier and the ARN of the finding provider.
NoteUpdate note
SeverityUpdate severity
Used to update the finding severity.
String verificationState
Indicates the veracity of a finding.
The available values for VerificationState are as follows.
UNKNOWN – The default disposition of a security finding
TRUE_POSITIVE – The security finding is confirmed
FALSE_POSITIVE – The security finding was determined to be a false alarm
BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any
threat, is expected, or both
Integer confidence
The updated value for the finding 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.
Integer criticality
The updated value for the level of importance assigned to the resources associated with the findings.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
List<E> types
One or more finding types in the format of namespace/category/classifier that classify a finding.
Valid namespace values are as follows.
Software and Configuration Checks
TTPs
Effects
Unusual Behaviors
Sensitive Data Identifications
Map<K,V> userDefinedFields
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
WorkflowUpdate workflow
Used to update the workflow status of a finding.
The workflow status indicates the progress of the investigation into the finding.
List<E> relatedFindings
A list of findings that are related to the updated findings.
AwsSecurityFindingIdentifier findingIdentifier
The identifier of the finding that was not updated.
String errorCode
The code associated with the error.
String errorMessage
The message associated with the error.
Long column
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.
Long row
The row number of the row that contains the data.
String columnName
The name of the column that contains the data.
String cellReference
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.
String cityName
The name of the city.
String mimeType
The type of content that the finding applies to.
Long sizeClassified
The total size in bytes of the affected data.
Boolean additionalOccurrences
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.
ClassificationStatus status
The current status of the sensitive data detection.
List<E> sensitiveData
Provides details about sensitive data that was identified based on built-in configuration.
CustomDataIdentifiersResult customDataIdentifiers
Provides details about sensitive data that was identified based on customer-defined configuration.
String status
The result of a standards check.
The valid values for Status are 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 was NOT_APPLICABLE. If the Config evaluation result was
NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.
List<E> relatedRequirements
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.
List<E> statusReasons
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.
String name
The name of the container related to a finding.
String imageId
The identifier of the image related to a finding.
String imageName
The name of the image related to a finding.
String launchedAt
Indicates when the container started.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String actionTargetArn
The ARN for the custom action target.
String name
The name of the custom insight to create.
AwsSecurityFindingFilters filters
One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.
String groupByAttribute
The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
String insightArn
The ARN of the insight created.
Long count
The total number of occurrences of sensitive data that were detected.
String arn
The ARN of the custom identifier that was used to detect the sensitive data.
String name
he name of the custom identifier that detected the sensitive data.
Occurrences occurrences
Details about the sensitive data that was detected.
String version
The version of CVSS for the CVSS score.
Double baseScore
The base CVSS score.
String baseVector
The base scoring vector for the CVSS score.
String source
The origin of the original CVSS score and vector.
List<E> adjustments
Adjustments to the CVSS metrics.
String detailedResultsLocation
The path to the folder or file that contains the sensitive data.
ClassificationResult result
The details about the sensitive data that was detected on the resource.
String actionTargetArn
The ARN of the custom action target to delete.
String actionTargetArn
The ARN of the custom action target that was deleted.
String insightArn
The ARN of the insight to delete.
String insightArn
The ARN of the insight that was deleted.
List<E> actionTargetArns
A list of custom action target ARNs for the custom action targets to retrieve.
String nextToken
The token that is required for pagination. On your first call to the DescribeActionTargets
operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Integer maxResults
The maximum number of results to return.
String hubArn
The ARN of the Hub resource to retrieve.
String hubArn
The ARN of the Hub resource that was retrieved.
String subscribedAt
The date and time when Security Hub was enabled in the account.
Boolean autoEnableControls
Whether to automatically enable new controls when they are added to standards that are enabled.
If set to true, then new controls for enabled standards are enabled automatically. If set to
false, then new controls are not enabled.
Boolean autoEnable
Whether to automatically enable Security Hub for new accounts in the organization.
If set to true, then Security Hub is enabled for new accounts. If set to false, then new accounts
are not added automatically.
Boolean memberAccountLimitReached
Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
String nextToken
The token that is required for pagination. On your first call to the DescribeProducts operation, set
the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Integer maxResults
The maximum number of results to return.
String productArn
The ARN of the integration to return.
String standardsSubscriptionArn
The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of
the standards you have enabled, use the GetEnabledStandards operation.
String nextToken
The token that is required for pagination. On your first call to the DescribeStandardsControls
operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Integer maxResults
The maximum number of security standard controls to return.
String nextToken
The token that is required for pagination. On your first call to the DescribeStandards operation,
set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Integer maxResults
The maximum number of standards to return.
String productSubscriptionArn
The ARN of the integrated product to disable the integration for.
String adminAccountId
The Amazon Web Services account identifier of the Security Hub administrator account.
String productArn
The ARN of the product to enable the integration for.
String productSubscriptionArn
The ARN of your subscription to the product to enable integrations for.
String adminAccountId
The Amazon Web Services account identifier of the account to designate as the Security Hub administrator account.
Map<K,V> tags
The tags to add to the hub resource when you enable Security Hub.
Boolean enableDefaultStandards
Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not
provide a value for EnableDefaultStandards, it is set to true. To not enable the
automatically enabled standards, set EnableDefaultStandards to false.
Integer confidence
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.
Integer criticality
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.
List<E> relatedFindings
A list of findings that are related to the current finding.
FindingProviderSeverity severity
The severity of a finding.
List<E> types
One or more finding types in the format of namespace/category/classifier that classify a finding.
Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
Invitation administrator
List<E> standardsSubscriptionArns
The list of the standards subscription ARNs for the standards to retrieve.
String nextToken
The token that is required for pagination. On your first call to the GetEnabledStandards operation,
set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Integer maxResults
The maximum number of results to return in the response.
AwsSecurityFindingFilters filters
The finding attributes used to define a condition to filter the returned findings.
You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.
Note that in the available filter fields, WorkflowState is deprecated. To search for a finding based
on its workflow status, use WorkflowStatus.
List<E> sortCriteria
The finding attributes used to sort the list of returned findings.
String nextToken
The token that is required for pagination. On your first call to the GetFindings operation, set the
value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Integer maxResults
The maximum number of findings to return.
String insightArn
The ARN of the insight for which to return results.
InsightResults insightResults
The insight results returned by the operation.
List<E> insightArns
The ARNs of the insights to describe. If you do not provide any insight ARNs, then GetInsights
returns all of your custom insights. It does not return any managed insights.
String nextToken
The token that is required for pagination. On your first call to the GetInsights operation, set the
value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Integer maxResults
The maximum number of items to return in the response.
Integer invitationsCount
The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation.
Invitation master
A list of details about the Security Hub administrator account for the current member account.
String insightArn
The ARN of a Security Hub insight.
String name
The name of a Security Hub insight.
AwsSecurityFindingFilters filters
One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.
String groupByAttribute
The grouping attribute for the insight's findings. Indicates how to group the matching findings, and identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
String insightArn
The ARN of the insight whose results are returned by the GetInsightResults operation.
String groupByAttribute
The attribute that the findings are grouped by for the insight whose results are returned by the
GetInsightResults operation.
List<E> resultValues
The list of insight result values returned by the GetInsightResults operation.
String code
String code
String code
String accountId
The account ID of the Security Hub administrator account that the invitation was sent from.
String invitationId
The ID of the invitation sent to the member account.
Date invitedAt
The timestamp of when the invitation was sent.
String memberStatus
The current status of the association between the member and administrator accounts.
String cidr
A finding's CIDR value.
String value
A value for the keyword.
String code
String nextToken
The token that is required for pagination. On your first call to the ListEnabledProductsForImport
operation, set the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Integer maxResults
The maximum number of items to return in the response.
Integer maxResults
The maximum number of items to return in the response.
String nextToken
The token that is required for pagination. On your first call to the ListInvitations operation, set
the value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Boolean onlyAssociated
Specifies which member accounts to include in the response based on their relationship status with the
administrator account. The default value is TRUE.
If OnlyAssociated is set to TRUE, the response includes member accounts whose
relationship status with the administrator account is set to ENABLED.
If OnlyAssociated is set to FALSE, the response includes all existing member accounts.
Integer maxResults
The maximum number of items to return in the response.
String nextToken
The token that is required for pagination. On your first call to the ListMembers operation, set the
value of this parameter to NULL.
For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
Integer maxResults
The maximum number of items to return in the response.
String nextToken
The token that is required for pagination. On your first call to the ListOrganizationAdminAccounts
operation, set the value of this parameter to NULL. For subsequent calls to the operation, to
continue listing data, set the value of this parameter to the value returned from the previous response.
String resourceArn
The ARN of the resource to retrieve tags for.
String key
The key of the map filter. For example, for ResourceTags, Key identifies the name of
the tag. For UserDefinedFields, Key is the name of the field.
String value
The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a
tag called Department might be Security. If you provide security as the
filter value, then there is no match.
String comparison
The condition to apply to the key value when querying for findings with a map filter.
To search for values that exactly match the filter value, use EQUALS. For example, for the
ResourceTags field, the filter Department EQUALS Security matches findings that have
the value Security for the tag Department.
To search for values other than the filter value, use NOT_EQUALS. For example, for the
ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that do
not have the value Finance for the tag Department.
EQUALS filters on the same field are joined by OR. A finding matches if it matches any
one of those filters.
NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it
matches all of those filters.
You cannot have both an EQUALS filter and a NOT_EQUALS filter on the same field.
String accountId
The Amazon Web Services account ID of the member account.
String email
The email address of the member account.
String masterId
This is replaced by AdministratorID.
The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.
String administratorId
The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.
String memberStatus
The status of the relationship between the member account and its administrator account.
The status can have one of the following values:
CREATED - Indicates that the administrator account added the member account, but has not yet invited
the member account.
INVITED - Indicates that the administrator account invited the member account. The member account
has not yet responded to the invitation.
ENABLED - Indicates that the member account is currently active. For manually invited member
accounts, indicates that the member account accepted the invitation.
REMOVED - Indicates that the administrator account disassociated the member account.
RESIGNED - Indicates that the member account disassociated themselves from the administrator
account.
DELETED - Indicates that the administrator account deleted the member account.
ACCOUNT_SUSPENDED - Indicates that an organization account was suspended from Amazon Web Services at
the same time that the administrator account tried to enable the organization account as a member account.
Date invitedAt
A timestamp for the date and time when the invitation was sent to the member account.
Date updatedAt
The timestamp for the date and time when the member account was updated.
String direction
The direction of network traffic associated with a finding.
String protocol
The protocol of network-related information about a finding.
PortRange openPortRange
The range of open ports that is present on the network.
String sourceIpV4
The source IPv4 address of network-related information about a finding.
String sourceIpV6
The source IPv6 address of network-related information about a finding.
Integer sourcePort
The source port of network-related information about a finding.
String sourceDomain
The source domain of network-related information about a finding.
String sourceMac
The source media access control (MAC) address of network-related information about a finding.
String destinationIpV4
The destination IPv4 address of network-related information about a finding.
String destinationIpV6
The destination IPv6 address of network-related information about a finding.
Integer destinationPort
The destination port of network-related information about a finding.
String destinationDomain
The destination domain of network-related information about a finding.
String connectionDirection
The direction of the network connection request (IN or OUT).
ActionRemoteIpDetails remoteIpDetails
Information about the remote IP address that issued the network connection request.
ActionRemotePortDetails remotePortDetails
Information about the port on the remote IP address.
ActionLocalPortDetails localPortDetails
Information about the port on the EC2 instance.
String protocol
The protocol used to make the network connection request.
Boolean blocked
Indicates whether the network connection attempt was blocked.
String protocol
The protocol used for the component.
NetworkPathComponentDetails destination
Information about the destination of the component.
NetworkPathComponentDetails source
Information about the origin of the component.
String componentId
The identifier of a component in the network path.
String componentType
The type of component.
NetworkHeader egress
Information about the component that comes after the current component in the network path.
NetworkHeader ingress
Information about the component that comes before the current node in the network path.
String text
The text of a note.
String updatedBy
The principal that created a note.
String updatedAt
The timestamp of when the note was updated.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
Double gte
The greater-than-equal condition to be applied to a single field when querying for findings.
Double lte
The less-than-equal condition to be applied to a single field when querying for findings.
Double eq
The equal-to condition to be applied to a single field when querying for findings.
List<E> lineRanges
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.
List<E> offsetRanges
Occurrences of sensitive data detected in a binary text file.
List<E> pages
Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.
List<E> records
Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.
List<E> cells
Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.
Long pageNumber
The page number of the page that contains the sensitive data.
Range lineRange
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.
Range offsetRange
An occurrence of sensitive data detected in a binary text file.
String id
The identifier of the compliance standard that was used to determine the patch compliance status.
Integer installedCount
The number of patches from the compliance standard that were installed successfully.
Integer missingCount
The number of patches that are part of the compliance standard but are not installed. The count includes patches that failed to install.
Integer failedCount
The number of patches from the compliance standard that failed to install.
Integer installedOtherCount
The number of installed patches that are not part of the compliance standard.
Integer installedRejectedCount
The number of patches that are installed but are also on a list of patches that the customer rejected.
Integer installedPendingReboot
The number of patches that were applied, but that require the instance to be rebooted in order to be marked as installed.
String operationStartTime
Indicates when the operation started.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String operationEndTime
Indicates when the operation completed.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String rebootOption
The reboot option specified for the instance.
String operation
The type of patch operation performed. For Patch Manager, the values are SCAN and
INSTALL.
ActionLocalPortDetails localPortDetails
Provides information about the port that was scanned.
ActionLocalIpDetails localIpDetails
Provides information about the IP address where the scanned port is located.
ActionRemoteIpDetails remoteIpDetails
Provides information about the remote IP address that performed the scan.
String name
The name of the process.
String path
The path to the process executable.
Integer pid
The process ID.
Integer parentPid
The parent process ID.
String launchedAt
Indicates when the process was launched.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String terminatedAt
Indicates when the process was terminated.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String productArn
The ARN assigned to the product.
String productName
The name of the product.
String companyName
The name of the company that provides the product.
String description
A description of the product.
List<E> categories
The categories assigned to the product.
List<E> integrationTypes
The types of integration that the product supports. Available values are the following.
SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to Security Hub.
RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings from Security Hub.
UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new findings to Security Hub, but
does make updates to the findings that it receives from Security Hub.
String marketplaceUrl
For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service.
For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product.
String activationUrl
The URL to the service or product documentation about the integration with Security Hub, including how to activate the integration.
String productSubscriptionResourcePolicy
The resource policy associated with the product.
Long start
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.
Long end
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.
Long startColumn
In the line where the sensitive data starts, the column within the line where the sensitive data starts.
String jsonPath
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.
Long recordIndex
The record index, starting from 0, for the record that contains the data.
Recommendation recommendation
A recommendation on the steps to take to remediate the issue identified by a finding.
String type
The type of the resource that details are provided for. If possible, set Type to one of the
supported resource types. For example, if the resource is an EC2 instance, then set Type to
AwsEc2Instance.
If the resource does not match any of the provided types, then set Type to Other.
String id
The canonical identifier for the given resource type.
String partition
The canonical Amazon Web Services partition name that the Region is assigned to.
String region
The canonical Amazon Web Services external Region name where this resource is located.
String resourceRole
Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,
Map<K,V> tags
A list of Amazon Web Services tags associated with a resource at the time the finding was processed.
DataClassificationDetails dataClassification
Contains information about sensitive data that was detected on the resource.
ResourceDetails details
Additional details about the resource related to a finding.
String code
AwsAutoScalingAutoScalingGroupDetails awsAutoScalingAutoScalingGroup
Details for an autoscaling group.
AwsCodeBuildProjectDetails awsCodeBuildProject
Details for an CodeBuild project.
AwsCloudFrontDistributionDetails awsCloudFrontDistribution
Details about a CloudFront distribution.
AwsEc2InstanceDetails awsEc2Instance
Details about an EC2 instance related to a finding.
AwsEc2NetworkInterfaceDetails awsEc2NetworkInterface
Details for an EC2 network interface.
AwsEc2SecurityGroupDetails awsEc2SecurityGroup
Details for an EC2 security group.
AwsEc2VolumeDetails awsEc2Volume
Details for an EC2 volume.
AwsEc2VpcDetails awsEc2Vpc
Details for an EC2 VPC.
AwsEc2EipDetails awsEc2Eip
Details about an Elastic IP address.
AwsEc2SubnetDetails awsEc2Subnet
Details about a subnet in Amazon EC2.
AwsEc2NetworkAclDetails awsEc2NetworkAcl
Details about an EC2 network access control list (ACL).
AwsElbv2LoadBalancerDetails awsElbv2LoadBalancer
Details about a load balancer.
AwsElasticBeanstalkEnvironmentDetails awsElasticBeanstalkEnvironment
Details about an Elastic Beanstalk environment.
AwsElasticsearchDomainDetails awsElasticsearchDomain
Details for an Elasticsearch domain.
AwsS3BucketDetails awsS3Bucket
Details about an S3 bucket related to a finding.
AwsS3AccountPublicAccessBlockDetails awsS3AccountPublicAccessBlock
Details about the Amazon S3 Public Access Block configuration for an account.
AwsS3ObjectDetails awsS3Object
Details about an S3 object related to a finding.
AwsSecretsManagerSecretDetails awsSecretsManagerSecret
Details about a Secrets Manager secret.
AwsIamAccessKeyDetails awsIamAccessKey
Details about an IAM access key related to a finding.
AwsIamUserDetails awsIamUser
Details about an IAM user.
AwsIamPolicyDetails awsIamPolicy
Details about an IAM permissions policy.
AwsApiGatewayV2StageDetails awsApiGatewayV2Stage
Provides information about a version 2 stage for Amazon API Gateway.
AwsApiGatewayV2ApiDetails awsApiGatewayV2Api
Provides information about a version 2 API in Amazon API Gateway.
AwsDynamoDbTableDetails awsDynamoDbTable
Details about a DynamoDB table.
AwsApiGatewayStageDetails awsApiGatewayStage
Provides information about a version 1 Amazon API Gateway stage.
AwsApiGatewayRestApiDetails awsApiGatewayRestApi
Provides information about a REST API in version 1 of Amazon API Gateway.
AwsCloudTrailTrailDetails awsCloudTrailTrail
Provides details about a CloudTrail trail.
AwsSsmPatchComplianceDetails awsSsmPatchCompliance
Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.
AwsCertificateManagerCertificateDetails awsCertificateManagerCertificate
Provides details about an Certificate Manager certificate.
AwsRedshiftClusterDetails awsRedshiftCluster
Contains details about an Amazon Redshift cluster.
AwsElbLoadBalancerDetails awsElbLoadBalancer
Contains details about a Classic Load Balancer.
AwsIamGroupDetails awsIamGroup
Contains details about an IAM group.
AwsIamRoleDetails awsIamRole
Details about an IAM role.
AwsKmsKeyDetails awsKmsKey
Details about an KMS key.
AwsLambdaFunctionDetails awsLambdaFunction
Details about a Lambda function.
AwsLambdaLayerVersionDetails awsLambdaLayerVersion
Details for a Lambda layer version.
AwsRdsDbInstanceDetails awsRdsDbInstance
Details about an Amazon RDS database instance.
AwsSnsTopicDetails awsSnsTopic
Details about an SNS topic.
AwsSqsQueueDetails awsSqsQueue
Details about an SQS queue.
AwsWafWebAclDetails awsWafWebAcl
Details for an WAF WebACL.
AwsRdsDbSnapshotDetails awsRdsDbSnapshot
Details about an Amazon RDS database snapshot.
AwsRdsDbClusterSnapshotDetails awsRdsDbClusterSnapshot
Details about an Amazon RDS database cluster snapshot.
AwsRdsDbClusterDetails awsRdsDbCluster
Details about an Amazon RDS database cluster.
AwsEcsClusterDetails awsEcsCluster
Details about an ECS cluster.
AwsEcsTaskDefinitionDetails awsEcsTaskDefinition
Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.
ContainerDetails container
Details about a container resource related to a finding.
Map<K,V> other
Details about a resource that are not available in a type-specific details object. Use the Other
object 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 Other object 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.
AwsRdsEventSubscriptionDetails awsRdsEventSubscription
Details about an RDS event notification subscription.
AwsEcsServiceDetails awsEcsService
Details about a service within an ECS cluster.
AwsAutoScalingLaunchConfigurationDetails awsAutoScalingLaunchConfiguration
Provides details about a launch configuration.
AwsEc2VpnConnectionDetails awsEc2VpnConnection
Details about an EC2 VPN connection.
AwsEcrContainerImageDetails awsEcrContainerImage
information about an Amazon ECR image.
String code
Long count
The total number of occurrences of sensitive data that were detected.
String type
The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.
Occurrences occurrences
Details about the sensitive data that was detected.
String category
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.
List<E> detections
The list of detected instances of sensitive data.
Long totalCount
The total number of occurrences of sensitive data.
Double product
Deprecated. This attribute is being deprecated. Instead of providing Product, provide
Original.
The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding.
String label
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 Normalized and do not provide Label, then Label is set
automatically as follows.
0 - INFORMATIONAL
1–39 - LOW
40–69 - MEDIUM
70–89 - HIGH
90–100 - CRITICAL
Integer normalized
Deprecated. The normalized severity of a finding. This attribute is being deprecated. Instead of providing
Normalized, provide Label.
If you provide Label and do not provide Normalized, then Normalized is set
automatically as follows.
INFORMATIONAL - 0
LOW - 1
MEDIUM - 40
HIGH - 70
CRITICAL - 90
String original
The native severity from the finding product that generated the finding.
Integer normalized
The normalized severity for the finding. This attribute is to be deprecated in favor of Label.
If you provide Normalized and do not provide Label, Label is set
automatically as follows.
0 - INFORMATIONAL
1–39 - LOW
40–69 - MEDIUM
70–89 - HIGH
90–100 - CRITICAL
Double product
The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding.
String label
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.
String name
The name of the software package.
String version
The version of the software package.
String epoch
The epoch of the software package.
String release
The release of the software package.
String architecture
The architecture used for the software package.
String packageManager
The source of the package.
String filePath
The file system path to the package manager inventory file.
String standardsArn
The ARN of a standard.
String name
The name of the standard.
String description
A description of the standard.
Boolean enabledByDefault
Whether the standard is enabled by default. When Security Hub is enabled from the console, if a standard is enabled by default, the check box for that standard is selected by default.
When Security Hub is enabled using the EnableSecurityHub API operation, the standard is enabled by
default unless EnableDefaultStandards is set to false.
String standardsControlArn
The ARN of the security standard control.
String controlStatus
The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.
String disabledReason
The reason provided for the most recent change in status for the control.
Date controlStatusUpdatedAt
The date and time that the status of the security standard control was most recently updated.
String controlId
The identifier of the security standard control.
String title
The title of the security standard control.
String description
The longer description of the security standard control. Provides information about what the control is checking for.
String remediationUrl
A link to remediation information for the control in the Security Hub user documentation.
String severityRating
The severity of findings generated from this security standard control.
The finding severity is based on an assessment of how easy it would be to compromise Amazon Web Services resources if the issue is detected.
List<E> relatedRequirements
The list of requirements that are related to this control.
String standardsSubscriptionArn
The ARN of a resource that represents your subscription to a supported standard.
String standardsArn
The ARN of a standard.
Map<K,V> standardsInput
A key-value pair of input for the standard.
String standardsStatus
The status of the standard subscription.
The status values are as follows:
PENDING - Standard is in the process of being enabled.
READY - Standard is enabled.
INCOMPLETE - Standard could not be enabled completely. Some controls may not be available.
DELETING - Standard is in the process of being disabled.
FAILED - Standard could not be disabled.
String reasonCode
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.
String description
The corresponding description for the status reason code.
String value
The string filter value. Filter values are case sensitive. For example, the product name for control-based
findings is Security Hub. If you provide security hub as the filter text, then there is
no match.
String comparison
The condition to apply to a string value when querying for findings. To search for values that contain the filter criteria value, use one of the following comparison operators:
To search for values that exactly match the filter value, use EQUALS.
For example, the filter ResourceType EQUALS AwsEc2SecurityGroup only matches findings that have a
resource type of AwsEc2SecurityGroup.
To search for values that start with the filter value, use PREFIX.
For example, the filter ResourceType PREFIX AwsIam matches findings that have a resource type that
starts with AwsIam. Findings with a resource type of AwsIamPolicy,
AwsIamRole, or AwsIamUser would all match.
EQUALS and PREFIX filters on the same field are joined by OR. A finding
matches if it matches any one of those filters.
To search for values that do not contain the filter criteria value, use one of the following comparison operators:
To search for values that do not exactly match the filter value, use NOT_EQUALS.
For example, the filter ResourceType NOT_EQUALS AwsIamPolicy matches findings that have a resource
type other than AwsIamPolicy.
To search for values that do not start with the filter value, use PREFIX_NOT_EQUALS.
For example, the filter ResourceType PREFIX_NOT_EQUALS AwsIam matches findings that have a resource
type that does not start with AwsIam. Findings with a resource type of AwsIamPolicy,
AwsIamRole, or AwsIamUser would all be excluded from the results.
NOT_EQUALS and PREFIX_NOT_EQUALS filters on the same field are joined by
AND. A finding matches only if it matches all of those filters.
For filters on the same field, you cannot provide both an EQUALS filter and a
NOT_EQUALS or PREFIX_NOT_EQUALS filter. Combining filters in this way always returns an
error, even if the provided filter values would return valid results.
You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes the PREFIX filters, then the
NOT_EQUALS or PREFIX_NOT_EQUALS filters.
For example, for the following filter, Security Hub first identifies findings that have resource types that start
with either AwsIAM or AwsEc2. It then excludes findings that have a resource type of
AwsIamPolicy and findings that have a resource type of AwsEc2NetworkInterface.
ResourceType PREFIX AwsIam
ResourceType PREFIX AwsEc2
ResourceType NOT_EQUALS AwsIamPolicy
ResourceType NOT_EQUALS AwsEc2NetworkInterface
String type
The type of threat intelligence indicator.
String value
The value of a threat intelligence indicator.
String category
The category of a threat intelligence indicator.
String lastObservedAt
Indicates when the most recent instance of a threat intelligence indicator was observed.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String source
The source of the threat intelligence indicator.
String sourceUrl
The URL to the page or site where you can get more information about the threat intelligence indicator.
AwsSecurityFindingFilters filters
A collection of attributes that specify which findings you want to update.
NoteUpdate note
The updated note for the finding.
String recordState
The updated record state for the finding.
String insightArn
The ARN of the insight that you want to update.
String name
The updated name for the insight.
AwsSecurityFindingFilters filters
The updated filters that define this insight.
String groupByAttribute
The updated GroupBy attribute that defines this insight.
Boolean autoEnable
Whether to automatically enable Security Hub for new accounts in the organization.
By default, this is false, and new accounts are not added automatically.
To automatically enable Security Hub for new accounts, set this to true.
Boolean autoEnableControls
Whether to automatically enable new controls when they are added to standards that are enabled.
By default, this is set to true, and new controls are enabled automatically. To not automatically
enable new controls, set this to false.
String standardsControlArn
The ARN of the security standard control to enable or disable.
String controlStatus
The updated status of the security standard control.
String disabledReason
A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.
String id
The identifier of the vulnerability.
List<E> vulnerablePackages
List of software packages that have the vulnerability.
List<E> cvss
CVSS scores from the advisory related to the vulnerability.
List<E> relatedVulnerabilities
List of vulnerabilities that are related to this vulnerability.
VulnerabilityVendor vendor
Information about the vendor that generates the vulnerability report.
List<E> referenceUrls
A list of URLs that provide additional information about the vulnerability.
String name
The name of the vendor.
String url
The URL of the vulnerability advisory.
String vendorSeverity
The severity that the vendor assigned to the vulnerability.
String vendorCreatedAt
Indicates when the vulnerability advisory was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String vendorUpdatedAt
Indicates when the vulnerability advisory was last updated.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
2020-03-22T13:22:13.933Z.
String type
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 specify
COUNT for the default action for a WebACL.
String ruleId
The unique identifier for the rule to exclude from the rule group.
String type
COUNT overrides the action specified by the individual rule within a RuleGroup .
If set to NONE, the rule's action takes place.
String status
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
SUPPRESSED or RESOLVED does 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 from NOTIFIED or RESOLVED to
NEW in the following cases:
RecordState changes from ARCHIVED to ACTIVE.
ComplianceStatus changes from PASSED to either WARNING,
FAILED, or NOT_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.
String status
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
SUPPRESSED or RESOLVED does 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 WorkFlowStatus from NOTIFIED or RESOLVED to
NEW in the following cases:
The record state changes from ARCHIVED to ACTIVE.
The compliance status changes from PASSED to either WARNING, FAILED, or
NOT_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.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed.
The finding is no longer updated.
Copyright © 2021. All rights reserved.