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 standardsId
The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.
AssociationStateDetails associationState
The state of the association between a route table and a subnet or gateway.
String gatewayId
The ID of the internet gateway or virtual private gateway.
Boolean main
Indicates whether this is the main route table.
String routeTableAssociationId
The ID of the association.
String routeTableId
The ID of the route table.
String subnetId
The ID of the subnet. A subnet ID is not returned for an implicit association.
String type
Specifies that the rule action should update the Types finding field. The Types finding
field classifies findings in the format of namespace/category/classifier. For more information, see Types taxonomy for ASFF in the Security Hub User Guide.
AutomationRulesFindingFieldsUpdate findingFieldsUpdate
Specifies that the automation rule action is an update to a finding field.
String ruleArn
The Amazon Resource Name (ARN) of a rule.
String ruleStatus
Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub
starts applying the rule to findings and finding updates after the rule is created.
Integer ruleOrder
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
String ruleName
The name of the rule.
String description
A description of the rule.
Boolean isTerminal
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
AutomationRulesFindingFilters criteria
A set of Amazon Web Services Security Finding Format finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.
List<E> actions
One or more actions to update finding fields if a finding matches the defined criteria of the rule.
Date createdAt
A timestamp that indicates when the rule 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.
Date updatedAt
A timestamp that indicates when the rule 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 createdBy
The principal that created a rule.
NoteUpdate note
SeverityUpdate severity
String verificationState
The rule action updates the VerificationState field of a finding.
Integer confidence
The rule action updates the Confidence field of a finding.
Integer criticality
The rule action updates the Criticality field of a finding.
List<E> types
The rule action updates the Types field of a finding.
Map<K,V> userDefinedFields
The rule action updates the UserDefinedFields field of a finding.
WorkflowUpdate workflow
List<E> relatedFindings
The rule action updates the RelatedFindings field of a finding.
List<E> productArn
The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> awsAccountId
The Amazon Web Services account ID in which a finding was generated.
Array Members: Minimum number of 1 item. Maximum number of 100 items.
List<E> id
The product-specific identifier for a finding.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> generatorId
The identifier for the solution-specific component that generated a finding.
Array Members: Minimum number of 1 item. Maximum number of 100 items.
List<E> type
One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the Security Hub User Guide.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> firstObservedAt
A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product.
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.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> lastObservedAt
A timestamp that indicates when the potential security issue captured by a finding was most recently observed by the security findings product.
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.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> createdAt
A timestamp that indicates when this finding record 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.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> updatedAt
A timestamp that indicates when the finding record 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.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> confidence
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. A value of 0 means 0 percent
confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration
detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration
hasn't been verified. For more information, see Confidence in the Security Hub User Guide.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> criticality
The level of importance that is assigned to the resources that are associated with a finding.
Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A
score of 0 means that the underlying resources have no criticality, and a score of 100
is reserved for the most critical resources. For more information, see Criticality in the Security Hub User Guide.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> title
A finding's title.
Array Members: Minimum number of 1 item. Maximum number of 100 items.
List<E> description
A finding's description.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> sourceUrl
Provides a URL that links to a page about the current finding in the finding product.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> productName
Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> companyName
The name of the company for the product that generated the finding. For control-based findings, the company is Amazon Web Services.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> severityLabel
The severity value of the finding.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> resourceType
The type of resource that the finding pertains to.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> resourceId
The identifier for the given resource type. For Amazon Web Services resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, this is the identifier as defined by the Amazon Web Service that created the resource. For non-Amazon Web Services resources, this is a unique identifier that is associated with the resource.
Array Members: Minimum number of 1 item. Maximum number of 100 items.
List<E> resourcePartition
The partition in which the resource that the finding pertains to is located. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> resourceRegion
The Amazon Web Services Region where the resource that a finding pertains to is located.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> resourceTags
A list of Amazon Web Services tags associated with a resource at the time the finding was processed.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> resourceDetailsOther
Custom fields and values about the resource that a finding pertains to.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> complianceStatus
The result of a security check. This field is only used for findings generated from controls.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> complianceSecurityControlId
The security control ID for which a finding was generated. Security control IDs are the same across standards.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> complianceAssociatedStandardsId
The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> verificationState
Provides the veracity of a finding.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> workflowStatus
Provides information about the status of the investigation into a finding.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> recordState
Provides the current state of a finding.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> relatedFindingsProductArn
The ARN for the product that generated a related finding.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> relatedFindingsId
The product-generated identifier for a related finding.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> noteText
The text of a user-defined note that's added to a finding.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> noteUpdatedAt
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.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> noteUpdatedBy
The principal that created a note.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
List<E> userDefinedFields
A list of user-defined name and value string pairs added to a finding.
Array Members: Minimum number of 1 item. Maximum number of 20 items.
String ruleArn
The Amazon Resource Name (ARN) for the rule.
String ruleStatus
Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub
starts applying the rule to findings and finding updates after the rule is created. To change the value of this
parameter after creating a rule, use
BatchUpdateAutomationRules .
Integer ruleOrder
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
String ruleName
The name of the rule.
String description
A description of the rule.
Boolean isTerminal
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
Date createdAt
A timestamp that indicates when the rule 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.
Date updatedAt
A timestamp that indicates when the rule 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 createdBy
The principal that created a rule.
String authenticationStrategy
The authentication strategy used to secure the broker. The default is SIMPLE.
Boolean autoMinorVersionUpgrade
Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
String brokerArn
The Amazon Resource Name (ARN) of the broker.
String brokerName
The broker's name.
String deploymentMode
The broker's deployment mode.
AwsAmazonMqBrokerEncryptionOptionsDetails encryptionOptions
Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.
String engineType
The type of broker engine.
String engineVersion
The version of the broker engine.
String hostInstanceType
The broker's instance type.
String brokerId
The unique ID that Amazon MQ generates for the broker.
AwsAmazonMqBrokerLdapServerMetadataDetails ldapServerMetadata
The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.
AwsAmazonMqBrokerLogsDetails logs
Turns on Amazon CloudWatch logging for brokers.
AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails maintenanceWindowStartTime
The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
Boolean publiclyAccessible
Permits connections from applications outside of the VPC that hosts the broker's subnets.
List<E> securityGroups
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
String storageType
The broker's storage type.
List<E> subnetIds
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
List<E> users
The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.
String kmsKeyId
The KMS key that’s used to encrypt your data at rest. If not provided, Amazon MQ will use a default KMS key to encrypt your data.
Boolean useAwsOwnedKey
Specifies that an KMS key should be used for at-rest encryption. Set to true by default if no value
is provided (for example, for RabbitMQ brokers).
List<E> hosts
Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
String roleBase
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
String roleName
The group name attribute in a role entry whose value is the name of that role.
String roleSearchMatching
The LDAP search filter used to find roles within the roleBase.
Boolean roleSearchSubtree
The directory search scope for the role. If set to true, the scope is to search the entire subtree.
String serviceAccountUsername
A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
String userBase
Selects a particular subtree of the directory information tree (DIT) to search for user entries.
String userRoleName
The name of the LDAP attribute in the user's directory entry for the user's group membership.
String userSearchMatching
The LDAP search filter used to find users within the userBase.
Boolean userSearchSubtree
The directory search scope for the user. If set to true, the scope is to search the entire subtree.
Boolean audit
Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.
Boolean general
Activates general logging.
String auditLogGroup
The location of the CloudWatch Logs log group where audit logs are sent.
String generalLogGroup
The location of the CloudWatch Logs log group where general logs are sent.
AwsAmazonMqBrokerLogsPendingDetails pending
The list of information about logs that are to be turned on for the specified broker.
String dayOfWeek
The day of the week on which the maintenance window falls.
String timeOfDay
The time, in 24-hour format, on which the maintenance window falls.
String timeZone
The time zone in either the Country/City format or the UTC offset format. UTC is the default format.
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.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
String lastSeen
An ISO8601-formatted timestamp that indicates when the API call was most recently observed.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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 authenticationType
The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig
The configuration for Lambda function authorization.
AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig
The OpenID Connect configuration.
AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig
The Amazon Cognito user pools configuration.
String apiId
The unique identifier for the API.
String id
The unique identifier for the API.
AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig
Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
String name
The API name.
AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig
Specifies the configuration for Lambda function authorization.
Boolean xrayEnabled
Indicates whether to use X-Ray tracing for the GraphQL API.
String arn
The Amazon Resource Name (ARN) of the API.
AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig
The Amazon Cognito user pools configuration.
String authenticationType
The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
AwsAppSyncGraphQlApiLogConfigDetails logConfig
The Amazon CloudWatch Logs configuration.
List<E> additionalAuthenticationProviders
A list of additional authentication providers for the GraphQL API.
String wafWebAclArn
The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
Integer authorizerResultTtlInSeconds
The number of seconds a response should be cached for. The default is 5 minutes (300 seconds).
String authorizerUri
The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.
String identityValidationExpression
A regular expression for validation of tokens before the Lambda function is called.
String cloudWatchLogsRoleArn
The Amazon Resource Name (ARN) of the service role that AppSync assumes to publish to CloudWatch Logs in your account.
Boolean excludeVerboseContent
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated
mapping templates, regardless of logging level.
String fieldLogLevel
The field logging level.
Long authTtL
The number of milliseconds that a token is valid after being authenticated.
String clientId
The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.
Long iatTtL
The number of milliseconds that a token is valid after it's issued to a user.
String issuer
The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of
iss in the ID token.
String appIdClientRegex
A regular expression for validating the incoming Amazon Cognito user pools app client ID. If this value isn't set, no filtering is applied.
String awsRegion
The Amazon Web Services Region in which the user pool was created.
String defaultAction
The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pools authentication doesn't match the Amazon Cognito user pools configuration.
String userPoolId
The user pool ID.
AwsAthenaWorkGroupConfigurationResultConfigurationDetails resultConfiguration
The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as client-side settings. If workgroup settings override client-side settings, then the query uses the workgroup settings.
AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails encryptionConfiguration
Specifies the method used to encrypt the user’s data stores in the Athena workgroup.
String encryptionOption
Indicates whether Amazon Simple Storage Service (Amazon S3) server-side encryption with Amazon S3 managed keys (SSE_S3), server-side encryption with KMS keys (SSE_KMS), or client-side encryption with KMS customer managed keys (CSE_KMS) is used.
String kmsKey
For SSE_KMS and CSE_KMS, this is the KMS key Amazon Resource Name (ARN) or ID.
String name
The workgroup name.
String description
The workgroup description.
String state
Whether the workgroup is enabled or disabled.
AwsAthenaWorkGroupConfigurationDetails configuration
The configuration of the workgroup, which includes the location in Amazon Simple Storage Service (Amazon S3) where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.
String value
The name of the Availability Zone.
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. Valid values are EC2 or ELB.
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, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails mixedInstancesPolicy
The mixed instances policy for the automatic scaling group.
List<E> availabilityZones
The list of Availability Zones for the automatic scaling group.
AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification launchTemplate
The launch template to use.
Boolean capacityRebalance
Indicates whether capacity rebalancing is enabled.
String launchTemplateId
The identifier of the launch template. You must specify either LaunchTemplateId or
LaunchTemplateName.
String launchTemplateName
The name of the launch template. You must specify either LaunchTemplateId or
LaunchTemplateName.
String version
Identifies the version of the launch template. You can specify a version identifier, or use the values
$Latest or $Default.
AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails instancesDistribution
The instances distribution. The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity.
AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails launchTemplate
The launch template to use and the instance types (overrides) to use to provision EC2 instances to fulfill On-Demand and Spot capacities.
String onDemandAllocationStrategy
How to allocate instance types to fulfill On-Demand capacity. The valid value is prioritized.
Integer onDemandBaseCapacity
The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
Integer onDemandPercentageAboveBaseCapacity
The percentage of On-Demand Instances and Spot Instances for additional capacity beyond
OnDemandBaseCapacity.
String spotAllocationStrategy
How to allocate instances across Spot Instance pools. Valid values are as follows:
lowest-price
capacity-optimized
capacity-optimized-prioritized
Integer spotInstancePools
The number of Spot Instance pools across which to allocate your Spot Instances.
String spotMaxPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance.
AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification launchTemplateSpecification
The launch template to use for a mixed instances policy.
List<E> overrides
Property values to use to override the values in the launch template.
String launchTemplateId
The identifier of the launch template. You must specify either LaunchTemplateId or
LaunchTemplateName.
String launchTemplateName
The name of the launch template. You must specify either LaunchTemplateId or
LaunchTemplateName.
String version
Identifies the version of the launch template. You can specify a version identifier, or use the values
$Latest or $Default.
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. Valid values are as follows:
gp2
gp3
io1
sc1
st1
standard
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, and date and time should be
separated by T. 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.
AwsAutoScalingLaunchConfigurationMetadataOptions metadataOptions
The metadata options for the instances.
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 httpEndpoint
Enables or disables the HTTP metadata endpoint on your instances. By default, the metadata endpoint is enabled.
Integer httpPutResponseHopLimit
The HTTP PUT response hop limit for instance metadata requests. The larger the number, the further
instance metadata requests can travel.
String httpTokens
Indicates whether token usage is required or optional for metadata requests. By
default, token usage is optional.
Map<K,V> backupOptions
Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid values are as follows:
Set to WindowsVSS: enabled to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to WindowsVSS: disabled to create a regular backup. The WindowsVSS option is not
enabled by default.
String resourceType
The name of a resource type. The only supported resource type is Amazon EC2 instances with Windows VSS.
The only valid value is EC2.
String backupPlanName
The display name of a backup plan.
List<E> advancedBackupSettings
A list of backup options for each resource type.
List<E> backupPlanRule
An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a
selection of resources.
AwsBackupBackupPlanBackupPlanDetails backupPlan
Uniquely identifies the backup plan to be associated with the selection of resources.
String backupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies the backup plan.
String backupPlanId
A unique ID for the backup plan.
String versionId
Unique, randomly generated, Unicode, UTF-8 encoded strings. Version IDs cannot be edited.
Long deleteAfterDays
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus
MoveToColdStorageAfterDays.
Long moveToColdStorageAfterDays
Specifies the number of days after creation that a recovery point is moved to cold storage.
String destinationBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.
AwsBackupBackupPlanLifecycleDetails lifecycle
Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
String targetBackupVault
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
Long startWindowMinutes
A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
String scheduleExpression
A cron expression in UTC specifying when Backup initiates a backup job.
String ruleName
A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
String ruleId
Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
Boolean enableContinuousBackup
Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
Long completionWindowMinutes
A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
List<E> copyActions
An array of CopyAction objects, each of which contains details of the copy operation.
AwsBackupBackupPlanLifecycleDetails lifecycle
Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
String encryptionKeyArn
The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support full Backup management. If you do not specify a key, Backup creates an KMS key for you by default.
AwsBackupBackupVaultNotificationsDetails notifications
The Amazon SNS event notifications for the specified backup vault.
String accessPolicy
A resource-based policy that is used to manage access permissions on the target backup vault.
List<E> backupVaultEvents
An array of events that indicate the status of jobs to back up resources to the backup vault. The following events are supported:
BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
String snsTopicArn
The Amazon Resource Name (ARN) that uniquely identifies the Amazon SNS topic for a backup vault's events.
String deleteAt
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus
MoveToColdStorageAfterDays.
String moveToColdStorageAt
Specifies the number of days after creation that a recovery point is moved to cold storage.
String backupPlanArn
An Amazon Resource Name (ARN) that uniquely identifies a backup plan.
String backupPlanId
Uniquely identifies a backup plan.
String backupPlanVersion
Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
String backupRuleId
Uniquely identifies a rule used to schedule the backup of a selection of resources.
Long backupSizeInBytes
The size, in bytes, of a backup.
String backupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault.
String backupVaultName
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
AwsBackupRecoveryPointCalculatedLifecycleDetails calculatedLifecycle
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
timestamps.
String completionDate
The date and time that a job to create a recovery point is completed, in Unix format and UTC. The value of
CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday,
January 26, 2018 12:11:30.087 AM.
AwsBackupRecoveryPointCreatedByDetails createdBy
Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan
that is used to create it.
String creationDate
The date and time a recovery point is created, in Unix format and UTC. The value of CreationDate is
accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
AM.
String encryptionKeyArn
The ARN for the server-side encryption key that is used to protect your backups.
String iamRoleArn
Specifies the IAM role ARN used to create the target recovery point
Boolean isEncrypted
A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or
FALSE if the recovery point is not encrypted.
String lastRestoreTime
The date and time that a recovery point was last restored, in Unix format and UTC. The value of
LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
AwsBackupRecoveryPointLifecycleDetails lifecycle
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define
String recoveryPointArn
An ARN that uniquely identifies a recovery point.
String resourceArn
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
String resourceType
The type of Amazon Web Services resource saved as a recovery point, such as an Amazon EBS volume or an Amazon RDS database.
String sourceBackupVaultArn
The ARN for the backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account, this value will be null.
String status
A status code specifying the state of the recovery point. Valid values are as follows:
COMPLETED
DELETING
EXPIRED
PARTIAL
String statusMessage
A message explaining the reason of the recovery point deletion failure.
String storageClass
Specifies the storage class of the recovery point. Valid values are as follows:
COLD
DELETED
WARM
Long deleteAfterDays
Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus
MoveToColdStorageAfterDays.
Long moveToColdStorageAfterDays
Specifies the number of days after creation that a recovery point is moved to cold storage.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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. This attribute is used only when RenewalStatus
is FAILED.
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, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
List<E> capabilities
The capabilities allowed in the stack.
String creationTime
The time at which the stack was created.
String description
A user-defined description associated with the stack.
Boolean disableRollback
Boolean to enable or disable rollback on stack creation failures.
AwsCloudFormationStackDriftInformationDetails driftInformation
Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.
Boolean enableTerminationProtection
Whether termination protection is enabled for the stack.
String lastUpdatedTime
The time the nested stack was last updated. This field will only be returned if the stack has been updated at least once.
List<E> notificationArns
The Amazon Resource Names (ARNs) of the Amazon SNS topic to which stack-related events are published.
List<E> outputs
A list of output structures.
String roleArn
The ARN of an IAM role that's associated with the stack.
String stackId
Unique identifier of the stack.
String stackName
The name associated with the stack.
String stackStatus
Current status of the stack.
String stackStatusReason
Success or failure message associated with the stack status.
Integer timeoutInMinutes
The length of time, in minutes, that CloudFormation waits for the nested stack to reach the
CREATE_COMPLETE state.
String stackDriftStatus
Status of the stack's actual configuration compared to its expected template configuration.
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, and date and time should be
separated by T. 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.
AwsCloudFrontDistributionViewerCertificate viewerCertificate
Provides information about the TLS/SSL configuration that the distribution uses to communicate with viewers.
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.
Integer httpPort
The HTTP port that CloudFront uses to connect to the origin.
Integer httpsPort
The HTTPS port that CloudFront uses to connect to the origin.
Integer originKeepaliveTimeout
Specifies how long, in seconds, CloudFront persists its connection to the origin.
String originProtocolPolicy
Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
Integer originReadTimeout
Specifies how long, in seconds, CloudFront waits for a response from the origin.
AwsCloudFrontDistributionOriginSslProtocols originSslProtocols
Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.
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.
AwsCloudFrontDistributionOriginCustomOriginConfig customOriginConfig
An origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static
website hosting, use this attribute. If the Amazon S3 bucket is not configured with static website hosting, use
the S3OriginConfig type instead.
String originAccessIdentity
The CloudFront origin access identity to associate with the origin.
String acmCertificateArn
The ARN of the ACM certificate. Used if the certificate is stored in ACM. If you provide an ACM certificate ARN,
you must also provide MinimumCertificateVersion and SslSupportMethod.
String certificate
The identifier of the certificate. Note that in CloudFront, this attribute is deprecated.
String certificateSource
The source of the certificate identified by Certificate. Note that in CloudFront, this attribute is
deprecated.
Boolean cloudFrontDefaultCertificate
Whether the distribution uses the CloudFront domain name. If set to false, then you provide either
AcmCertificateArn or IamCertificateId.
String iamCertificateId
The identifier of the IAM certificate. Used if the certificate is stored in IAM. If you provide
IamCertificateId, then you also must provide MinimumProtocolVersion and
SslSupportMethod.
String minimumProtocolVersion
The security policy that CloudFront uses for HTTPS connections with viewers. If SslSupportMethod is
sni-only, then MinimumProtocolVersion must be TLSv1 or higher.
String sslSupportMethod
The viewers that the distribution accepts HTTPS connections from.
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.
Boolean actionsEnabled
Indicates whether actions should be executed during any changes to the alarm state.
List<E> alarmActions
The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an
ALARM state from any other state.
String alarmArn
The ARN of the alarm.
String alarmConfigurationUpdatedTimestamp
The time stamp of the last update to the alarm configuration.
String alarmDescription
The description of the alarm.
String alarmName
The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.
String comparisonOperator
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
Integer datapointsToAlarm
The number of datapoints that must be breaching to trigger the alarm.
List<E> dimensions
The dimensions for the metric associated with the alarm.
String evaluateLowSampleCountPercentile
Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods
with too few data points to be statistically significant. If evaluate or this parameter is not used,
the alarm is always evaluated and possibly changes state no matter how many data points are available.
Integer evaluationPeriods
The number of periods over which data is compared to the specified threshold.
String extendedStatistic
The percentile statistic for the metric associated with the alarm.
List<E> insufficientDataActions
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other
state. Each action is specified as an ARN.
String metricName
The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm
based on a math expression, you use Metrics instead and you can't specify MetricName.
String namespace
The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an
alarm based on a math expression, you can't specify Namespace and you use Metrics
instead.
List<E> okActions
The actions to execute when this alarm transitions to the OK state from any other state. Each action
is specified as an ARN.
Integer period
The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.
String statistic
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic.
For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic
but not both.
For an alarm based on a math expression, you can't specify Statistic. Instead, you use
Metrics.
Double threshold
The value to compare with the specified statistic.
String thresholdMetricId
n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
function used as the threshold for the alarm.
String treatMissingData
Sets how this alarm is to handle missing data points.
String unit
The unit of the metric associated with the alarm.
String artifactIdentifier
An identifier for the artifact definition.
Boolean encryptionDisabled
Indicates whether to disable encryption on the artifact. Only valid when Type is S3.
String location
Only used when Type is S3. The name of the S3 bucket where the artifact is located.
String name
Only used when Type is S3. The name of the artifact. Used with NamepaceType and Path to
determine the pattern for storing the artifact.
String namespaceType
Only used when Type is S3. The value to use for the namespace. Used with
Name and Path to determine the pattern for storing the artifact.
Boolean overrideArtifactName
Whether the name specified in the buildspec file overrides the artifact name.
String packaging
Only used when Type is S3. The type of output artifact to create.
String path
Only used when Type is S3. The path to the artifact. Used with Name and
NamespaceType to determine the pattern for storing the artifact.
String type
The type of build artifact.
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).
List<E> artifacts
Information about the build artifacts for the CodeBuild project.
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.
AwsCodeBuildProjectLogsConfigDetails logsConfig
Information about logs for the build project.
AwsCodeBuildProjectVpcConfig vpcConfig
Information about the VPC configuration that CodeBuild accesses.
List<E> secondaryArtifacts
Information about the secondary artifacts for the CodeBuild project.
String certificate
The certificate to use with this build project.
List<E> environmentVariables
A set of environment variables to make available to builds for the build project.
Boolean privilegedMode
Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build
project is used to build Docker images.
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.
AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails cloudWatchLogs
Information about CloudWatch Logs for the build project.
AwsCodeBuildProjectLogsConfigS3LogsDetails s3Logs
Information about logs built to an S3 bucket for a build project.
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 certificateArn
The Amazon Resource Name (ARN) for the SSL certificate that encrypts connections between the DMS endpoint and the replication instance.
String databaseName
The name of the endpoint database.
String endpointArn
The Amazon Resource Name (ARN) of the endpoint.
String endpointIdentifier
The database endpoint identifier.
String endpointType
The type of endpoint. Valid values are source and target.
String engineName
The type of engine for the endpoint, depending on the EndpointType value.
String externalId
A value that can be used for cross-account validation.
String extraConnectionAttributes
Additional attributes associated with the connection.
String kmsKeyId
An DMS key identifier that is used to encrypt the connection parameters for the endpoint. If you don't specify a
value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default
encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default
encryption key for each Amazon Web Services Region.
Integer port
The port used to access the endpoint.
String serverName
The name of the server where the endpoint database resides.
String sslMode
The SSL mode used to connect to the endpoint. The default is none.
String username
The user name to be used to log in to the endpoint database.
Integer allocatedStorage
The amount of storage (in gigabytes) that is allocated for the replication instance.
Boolean autoMinorVersionUpgrade
Indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
String availabilityZone
The Availability Zone that the replication instance is created in. The default value is a random, system-chosen
Availability Zone in the endpoint's Amazon Web Services Region, such as us-east-1d.
String engineVersion
The engine version number of the replication instance. If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
String kmsKeyId
An KMS key identifier that is used to encrypt the data on the replication instance. If you don't specify a value
for the KmsKeyId parameter, DMS uses your default encryption key. KMS creates the default encryption
key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key
for each Amazon Web Services Region.
Boolean multiAZ
Specifies whether the replication instance is deployed across multiple Availability Zones (AZs). You can't set
the AvailabilityZone parameter if the MultiAZ parameter is set to true.
String preferredMaintenanceWindow
The maintenance window times for the replication instance. Upgrades to the replication instance are performed during this time.
Boolean publiclyAccessible
Specifies the accessibility options for the replication instance. A value of true represents an
instance with a public IP address. A value of false represents an instance with a private IP
address. The default value is true.
String replicationInstanceClass
The compute and memory capacity of the replication instance as defined for the specified replication instance class.
String replicationInstanceIdentifier
The replication instance identifier.
AwsDmsReplicationInstanceReplicationSubnetGroupDetails replicationSubnetGroup
The subnet group for the replication instance.
List<E> vpcSecurityGroups
The virtual private cloud (VPC) security group for the replication instance.
String replicationSubnetGroupIdentifier
The identifier of the replication subnet group.
String vpcSecurityGroupId
The identifier of the VPC security group that’s associated with the replication instance.
String cdcStartPosition
Indicates when you want a change data capture (CDC) operation to start. CCdcStartPosition or
CCdcStartTime specifies when you want a CDC operation to start. Only a value for one of these fields
is included.
String cdcStartTime
Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime
specifies when you want a CDC operation to start. Only a value for one of these fields is included.
String cdcStopPosition
Indicates when you want a CDC operation to stop. The value can be either server time or commit time.
String migrationType
The migration type.
String id
The identifier of the replication task.
String resourceIdentifier
A display name for the resource identifier at the end of the EndpointArn response parameter. If you
don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of
EndpointArn.
String replicationInstanceArn
The Amazon Resource Name (ARN) of a replication instance.
String replicationTaskIdentifier
The user-defined replication task identifier or name.
String replicationTaskSettings
The settings for the replication task.
String sourceEndpointArn
The ARN of the source endpoint.
String tableMappings
The table mappings for the replication task, in JSON format.
String targetEndpointArn
The ARN of the target endpoint.
String taskData
Supplemental information that the task requires to migrate the data for certain source and target endpoints.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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. Valid values are as follows:
ACTIVE
ARCHIVED
ARCHIVING
CREATING
DELETING
INACCESSIBLE_ENCRYPTION_CREDENTIALS
UPDATING
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.
ACTIVE
CREATING
DELETING
UPDATING
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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. Valid values are as follows:
ACTIVE
CREATING
CREATION_FAILED
DELETING
UPDATING
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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 virtualizationType
The virtualization type of the Amazon Machine Image (AMI) required to launch the instance.
AwsEc2InstanceMetadataOptions metadataOptions
Details about the metadata options for the Amazon EC2 instance.
AwsEc2InstanceMonitoringDetails monitoring
Describes the type of monitoring that’s turned on for an instance.
String httpEndpoint
Enables or disables the HTTP metadata endpoint on the instance.
String httpProtocolIpv6
Enables or disables the IPv6 endpoint for the instance metadata service.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
String httpTokens
The state of token usage for your instance metadata requests.
String instanceMetadataTags
Specifies whether to allow access to instance tags from the instance metadata.
String state
Indicates whether detailed monitoring is turned on. Otherwise, basic monitoring is turned on.
String networkInterfaceId
The identifier of the network interface. The details are in a corresponding
AwsEc2NetworkInterfacesDetails object.
String deviceName
The device name.
AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails ebs
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
String noDevice
Omits the device from the block device mapping when an empty string is specified.
String virtualName
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with
2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.
The number of available instance store volumes depends on the instance type.
Boolean deleteOnTermination
Indicates whether the EBS volume is deleted on instance termination.
Boolean encrypted
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you're creating a volume from a snapshot, you can't specify an encryption value.
Integer iops
The number of I/O operations per second (IOPS).
String kmsKeyId
The Amazon Resource Name (ARN) of the symmetric Key Management Service (KMS) customer managed key used for encryption.
String snapshotId
The ID of the EBS snapshot.
Integer throughput
The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Integer volumeSize
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.
String volumeType
The volume type.
String capacityReservationPreference
Indicates the instance's Capacity Reservation preferences. If equal to open, the instance can run in
any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). If equal
to none, the instance avoids running in a Capacity Reservation even if one is available. The
instance runs in On-Demand capacity.
AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails capacityReservationTarget
Specifies a target Capacity Reservation.
String cpuCredits
The credit option for CPU usage of a T instance.
List<E> blockDeviceMappingSet
Information about a block device mapping for an Amazon EC2 launch template.
AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails capacityReservationSpecification
Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.
AwsEc2LaunchTemplateDataCpuOptionsDetails cpuOptions
Specifies the CPU options for an instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.
AwsEc2LaunchTemplateDataCreditSpecificationDetails creditSpecification
Specifies the credit option for CPU usage of a T2, T3, or T3a instance.
Boolean disableApiStop
Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection in the Amazon EC2 User Guide.
Boolean disableApiTermination
If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console,
CLI, or API. If set to true, you can.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O.
List<E> elasticGpuSpecificationSet
Provides details about Elastic Graphics accelerators to associate with the instance.
List<E> elasticInferenceAcceleratorSet
The Amazon Elastic Inference accelerator for the instance.
AwsEc2LaunchTemplateDataEnclaveOptionsDetails enclaveOptions
Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.
AwsEc2LaunchTemplateDataHibernationOptionsDetails hibernationOptions
Specifies whether your Amazon EC2 instance is configured for hibernation.
AwsEc2LaunchTemplateDataIamInstanceProfileDetails iamInstanceProfile
The name or Amazon Resource Name (ARN) of an IAM instance profile.
String imageId
The ID of the Amazon Machine Image (AMI).
String instanceInitiatedShutdownBehavior
Provides the options for specifying the instance initiated shutdown behavior.
AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails instanceMarketOptions
Specifies the market (purchasing) option for an instance.
AwsEc2LaunchTemplateDataInstanceRequirementsDetails instanceRequirements
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance
types with these attributes. If you specify InstanceRequirements, you can't specify
InstanceType.
String instanceType
The instance type. For more information, see Instance types in the
Amazon EC2 User Guide. If you specify InstanceType, you can't specify
InstanceRequirements.
String kernelId
The ID of the kernel.
String keyName
The name of the key pair that allows users to connect to the instance.
List<E> licenseSet
Specifies a license configuration for an instance.
AwsEc2LaunchTemplateDataMaintenanceOptionsDetails maintenanceOptions
The maintenance options of your instance.
AwsEc2LaunchTemplateDataMetadataOptionsDetails metadataOptions
The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
AwsEc2LaunchTemplateDataMonitoringDetails monitoring
The monitoring for the instance.
List<E> networkInterfaceSet
Specifies the parameters for a network interface that is attached to the instance.
AwsEc2LaunchTemplateDataPlacementDetails placement
Specifies the placement of an instance.
AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails privateDnsNameOptions
The options for the instance hostname.
String ramDiskId
The ID of the RAM disk.
List<E> securityGroupIdSet
One or more security group IDs.
List<E> securityGroupSet
One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
String userData
The user data to make available to the instance.
String type
The type of Elastic Graphics accelerator.
Boolean enabled
If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves.
Boolean configured
If you set this parameter to true, the instance is enabled for hibernation.
String marketType
The market type.
AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails spotOptions
The options for Spot Instances.
Integer blockDurationMinutes
Deprecated.
String instanceInterruptionBehavior
The behavior when a Spot Instance is interrupted.
String maxPrice
The maximum hourly price you're willing to pay for the Spot Instances.
String spotInstanceType
The Spot Instance request type.
String validUntil
The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ), for persistent requests.
AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails acceleratorCount
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
List<E> acceleratorManufacturers
Indicates whether instance types must have accelerators by specific manufacturers.
List<E> acceleratorNames
The accelerators that must be on the instance type.
AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails acceleratorTotalMemoryMiB
The minimum and maximum amount of total accelerator memory, in MiB.
List<E> acceleratorTypes
The accelerator types that must be on the instance type.
String bareMetal
Indicates whether bare metal instance types must be included, excluded, or required.
AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails baselineEbsBandwidthMbps
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS optimized instances in the Amazon EC2 User Guide.
String burstablePerformance
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, Burstable performance instances in the Amazon EC2 User Guide.
List<E> cpuManufacturers
The CPU manufacturers to include.
List<E> excludedInstanceTypes
The instance types to exclude.
List<E> instanceGenerations
Indicates whether current or previous generation instance types are included.
String localStorage
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.
List<E> localStorageTypes
The type of local storage that is required.
AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails memoryGiBPerVCpu
The minimum and maximum amount of memory per vCPU, in GiB.
AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails memoryMiB
The minimum and maximum amount of memory, in MiB.
AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails networkInterfaceCount
The minimum and maximum number of network interfaces.
Integer onDemandMaxPricePercentageOverLowestPrice
The price protection threshold for On-Demand Instances. This is the maximum you'll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
A high value, such as 999999, turns off price protection.
Boolean requireHibernateSupport
Indicates whether instance types must support hibernation for On-Demand Instances.
Integer spotMaxPricePercentageOverLowestPrice
The price protection threshold for Spot Instances. This is the maximum you'll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
A high value, such as 999999, turns off price protection.
AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails totalLocalStorageGB
The minimum and maximum amount of total local storage, in GB.
AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails vCpuCount
The minimum and maximum number of vCPUs.
String licenseConfigurationArn
The Amazon Resource Name (ARN) of the license configuration.
String autoRecovery
Disables the automatic recovery behavior of your instance or sets it to default.
String httpEndpoint
Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled, and you won't be able to access your instance metadata.
String httpProtocolIpv6
Enables or disables the IPv6 endpoint for the instance metadata service.
String httpTokens
The state of token usage for your instance metadata requests.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
String instanceMetadataTags
When set to enabled, this parameter allows access to instance tags from the instance metadata. When
set to disabled, it turns off access to instance tags from the instance metadata. For more
information, see Work with
instance tags in instance metadata in the Amazon EC2 User Guide.
Boolean enabled
Enables detailed monitoring when true is specified. Otherwise, basic monitoring is enabled. For more
information about detailed monitoring, see Enable or turn off detailed
monitoring for your instances in the Amazon EC2 User Guide.
Boolean associateCarrierIpAddress
Indicates whether to associate a Carrier IP address with eth0 for a new network interface. You use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information, see Carrier IP address in the Wavelength Developer Guide.
Boolean associatePublicIpAddress
Associates a public IPv4 address with eth0 for a new network interface.
Boolean deleteOnTermination
Indicates whether the network interface is deleted when the instance is terminated.
String description
A description for the network interface.
Integer deviceIndex
The device index for the network interface attachment.
List<E> groups
The IDs of one or more security groups.
String interfaceType
The type of network interface.
Integer ipv4PrefixCount
The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if
you use the Ipv4Prefixes option.
List<E> ipv4Prefixes
One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv4PrefixCount option.
Integer ipv6AddressCount
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6
addresses from the subnet range. You can't use this option if you use Ipv6Addresses.
List<E> ipv6Addresses
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if
you use Ipv6AddressCount.
Integer ipv6PrefixCount
The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if
you use the Ipv6Prefix option.
List<E> ipv6Prefixes
One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the
Ipv6PrefixCount option.
Integer networkCardIndex
The index of the network card. Some instance types support multiple network cards. The primary network interface
must be assigned to network card index 0. The default is network card index 0.
String networkInterfaceId
The ID of the network interface.
String privateIpAddress
The primary private IPv4 address of the network interface.
List<E> privateIpAddresses
One or more private IPv4 addresses.
Integer secondaryPrivateIpAddressCount
The number of secondary private IPv4 addresses to assign to a network interface.
String subnetId
The ID of the subnet for the network interface.
String ipv4Prefix
The IPv4 prefix. For more information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
String ipv6Address
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.
String ipv6Prefix
The IPv6 prefix.
String affinity
The affinity setting for an instance on an EC2 Dedicated Host.
String availabilityZone
The Availability Zone for the instance.
String groupName
The name of the placement group for the instance.
String hostId
The ID of the Dedicated Host for the instance.
String hostResourceGroupArn
The Amazon Resource Name (ARN) of the host resource group in which to launch the instances.
Integer partitionNumber
The number of the partition the instance should launch in.
String spreadDomain
Reserved for future use.
String tenancy
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
Boolean enableResourceNameDnsAAAARecord
Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
Boolean enableResourceNameDnsARecord
Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
String hostnameType
The type of hostname for EC2 instances.
String launchTemplateName
A name for the launch template.
String id
An ID for the launch template.
AwsEc2LaunchTemplateDataDetails launchTemplateData
The information to include in the launch template.
Long defaultVersionNumber
The default version of the launch template.
Long latestVersionNumber
The latest version of the launch template.
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, and date and time should be
separated by T. 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.
List<E> associationSet
The associations between a route table and one or more subnets or a gateway.
String ownerId
The ID of the Amazon Web Services account that owns the route table.
List<E> propagatingVgwSet
Describes a virtual private gateway propagating route.
String routeTableId
The ID of the route table.
List<E> routeSet
The routes in the route table.
String vpcId
The ID of the virtual private cloud (VPC).
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. Valid values are available or pending.
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 id
The ID of the transit gateway.
String description
The description of the transit gateway.
String defaultRouteTablePropagation
Turn on or turn off automatic propagation of routes to the default propagation route table.
String autoAcceptSharedAttachments
Turn on or turn off automatic acceptance of attachment requests.
String defaultRouteTableAssociation
Turn on or turn off automatic association with the default association route table.
List<E> transitGatewayCidrBlocks
The transit gateway Classless Inter-Domain Routing (CIDR) blocks.
String associationDefaultRouteTableId
The ID of the default association route table.
String propagationDefaultRouteTableId
The ID of the default propagation route table.
String vpnEcmpSupport
Turn on or turn off Equal Cost Multipath Protocol (ECMP) support.
String dnsSupport
Turn on or turn off DNS support.
String multicastSupport
Indicates whether multicast is supported on the transit gateway.
Integer amazonSideAsn
A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
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. Valid values are as follows:
attaching
attached
busy
detaching
detached
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, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
String deviceName
The device name for the volume that is attached to the instance.
Boolean encrypted
Specifies 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. Valid values are as follows:
available
creating
deleted
deleting
error
in-use
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.
String volumeId
The ID of the volume.
String volumeType
The volume type.
String volumeScanStatus
Indicates whether the volume was scanned or skipped.
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. Valid values are available or pending.
Boolean acceptanceRequired
Whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
List<E> availabilityZones
The Availability Zones where the service is available.
List<E> baseEndpointDnsNames
The DNS names for the service.
Boolean managesVpcEndpoints
Whether the service manages its VPC endpoints.
List<E> gatewayLoadBalancerArns
The ARNs of the Gateway Load Balancers for the service.
List<E> networkLoadBalancerArns
The ARNs of the Network Load Balancers for the service.
String privateDnsName
The private DNS name for the service.
String serviceId
The identifier of the service.
String serviceName
The name of the service.
String serviceState
The current state of the service. Valid values are as follows:
Available
Deleted
Deleting
Failed
Pending
List<E> serviceType
The types for the service.
String serviceType
The type of service.
AwsEc2VpcPeeringConnectionVpcInfoDetails accepterVpcInfo
Information about the accepter VPC.
String expirationTime
The time at which an unaccepted VPC peering connection will expire.
AwsEc2VpcPeeringConnectionVpcInfoDetails requesterVpcInfo
Information about the requester VPC.
AwsEc2VpcPeeringConnectionStatusDetails status
The status of the VPC peering connection.
String vpcPeeringConnectionId
The ID of the VPC peering connection.
String cidrBlock
The IPv4 CIDR block for the VPC.
List<E> cidrBlockSet
Information about the IPv4 CIDR blocks for the VPC.
List<E> ipv6CidrBlockSet
The IPv6 CIDR block for the VPC.
String ownerId
The ID of the Amazon Web Services account that owns the VPC.
VpcInfoPeeringOptionsDetails peeringOptions
Information about the VPC peering connection options for the accepter or requester VPC.
String region
The Amazon Web Services Region in which the VPC is located.
String vpcId
The ID of the VPC.
String vpnConnectionId
The identifier of the VPN connection.
String state
The current state of the VPN connection. Valid values are as follows:
available
deleted
deleting
pending
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, and date and time should be
separated by T. 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. Valid values are DOWN or UP.
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. Valid values are as follows:
arm64
i386
x86_64
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, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
String arn
The ARN of the repository.
AwsEcrRepositoryImageScanningConfigurationDetails imageScanningConfiguration
The image scanning configuration for a repository.
String imageTagMutability
The tag mutability setting for the repository. Valid values are IMMUTABLE or MUTABLE.
AwsEcrRepositoryLifecyclePolicyDetails lifecyclePolicy
Information about the lifecycle policy for the repository.
String repositoryName
The name of the repository.
String repositoryPolicyText
The text of the repository policy.
Boolean scanOnPush
Whether to scan images after they are pushed to a repository.
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.
String clusterArn
The Amazon Resource Name (ARN) that identifies the cluster.
Integer activeServicesCount
The number of services that are running on the cluster in an ACTIVE state. You can view these
services with the Amazon ECS ListServices
API operation.
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.
String clusterName
A name that you use to identify your cluster.
Integer registeredContainerInstancesCount
The number of container instances registered into the cluster. This includes container instances in both
ACTIVE and DRAINING status.
Integer runningTasksCount
The number of tasks in the cluster that are in the RUNNING state.
String status
The status of the cluster.
String name
The name of the container.
String image
The image used for the container.
List<E> mountPoints
The mount points for data volumes in your container.
Boolean privileged
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
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.
String condition
The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start. Valid values are as follows:
COMPLETE
HEALTHY
SUCCESS
START
String containerName
The name of the dependent container.
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. Valid values are fluentbit or fluentd.
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.
List<E> add
The Linux capabilities for the container that are added to the default configuration provided by Docker. Valid values are as follows:
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" |
"BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" |
"DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" |
"IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" |
"MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" |
"NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP"
| "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" |
"SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" |
"SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" |
"SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
List<E> drop
The Linux capabilities for the container that are dropped from the default configuration provided by Docker.
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" |
"BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" |
"DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" |
"IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" |
"MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" |
"NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP"
| "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" |
"SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" |
"SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" |
"SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
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 containerPath
The absolute file path where the tmpfs volume is to be mounted.
List<E> mountOptions
The list of tmpfs volume mount options.
Valid values: "defaults" | "ro" | "rw" | "suid" |
"nosuid" | "dev" | "nodev" | "exec" | "noexec" |
"sync" | "async" | "dirsync" | "remount" |
"mand" | "nomand" | "atime" | "noatime" |
"diratime" | "nodiratime" | "bind" | "rbind" |
"unbindable" | "runbindable" | "private" | "rprivate" |
"shared" | "rshared" | "slave" | "rslave" |
"relatime" | "norelatime" | "strictatime" | "nostrictatime" |
"mode" | "uid" | "gid" | "nr_inodes" |
"nr_blocks" | "mpol"
Integer size
The maximum size (in MiB) of the tmpfs volume.
String logDriver
The log driver to use for the container.
Valid values on Fargate are as follows:
awsfirelens
awslogs
splunk
Valid values on Amazon EC2 are as follows:
awsfirelens
awslogs
fluentd
gelf
journald
json-file
logentries
splunk
syslog
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. Valid values are GPU or
InferenceAccelerator.
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.Valid values are as follows:
256 (.25 vCPU)
512 (.5 vCPU)
1024 (1 vCPU)
2048 (2 vCPU)
4096 (4 vCPU)
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 inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:
host
none
task
String memory
The amount (in MiB) of memory used by the task.
For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory
value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines
your range of supported values for the Cpu and Memory parameters.
String networkMode
The Docker networking mode to use for the containers in the task. Valid values are as follows:
awsvpc
bridge
host
none
String pidMode
The process namespace to use for the containers in the task. Valid values are host or
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 status
The status of the task definition.
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. Valid values are shared or task.
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 clusterArn
The Amazon Resource Name (ARN) of the cluster that hosts the task.
String taskDefinitionArn
The ARN of the task definition that creates the task.
String version
The version counter for the task.
String createdAt
The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task
entered the PENDING state.
String startedAt
The Unix timestamp for the time when the task started. More specifically, it's for the time when the task
transitioned from the PENDING state to the RUNNING state.
String startedBy
The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy
parameter contains the deployment ID of that service.
String group
The name of the task group that's associated with the task.
List<E> volumes
Details about the data volume that is used in a task definition.
List<E> containers
The containers that are associated with the task.
String name
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed. This name is referenced in the sourceVolume parameter of container definition
mountPoints.
AwsEcsTaskVolumeHostDetails host
This parameter is specified when you use bind mount host volumes. The contents of the host parameter
determine whether your bind mount host volume persists on the host container instance and where it's stored.
String sourcePath
When the host parameter is used, specify a sourcePath to declare the path on the host
container instance that's presented to the container.
String accessPointId
The ID of the Amazon EFS access point.
String arn
The Amazon Resource Name (ARN) of the Amazon EFS access point.
String clientToken
The opaque string specified in the request to ensure idempotent creation.
String fileSystemId
The ID of the Amazon EFS file system that the access point applies to.
AwsEfsAccessPointPosixUserDetails posixUser
The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point, that is used for all file operations by NFS clients using the access point.
AwsEfsAccessPointRootDirectoryDetails rootDirectory
The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
String gid
The POSIX group ID used for all file system operations using this access point.
List<E> secondaryGids
Secondary POSIX group IDs used for all file system operations using this access point.
String uid
The POSIX user ID used for all file system operations using this access point.
String ownerGid
Specifies the POSIX group ID to apply to the root directory.
String ownerUid
Specifies the POSIX user ID to apply to the root directory.
String permissions
Specifies the POSIX permissions to apply to the root directory, in the format of an octal number representing the file's mode bits.
AwsEfsAccessPointRootDirectoryCreationInfoDetails creationInfo
Specifies the POSIX IDs and permissions to apply to the access point's root directory.
String path
Specifies the path on the Amazon EFS file system to expose as the root directory to NFS clients using the access
point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not
exist, you are required to provide CreationInfo.
String arn
The ARN of the cluster.
String certificateAuthorityData
The certificate authority data for the cluster.
String clusterStatus
The status of the cluster. Valid values are as follows:
ACTIVE
CREATING
DELETING
FAILED
PENDING
UPDATING
String endpoint
The endpoint for the Amazon EKS API server.
String name
The name of the cluster.
AwsEksClusterResourcesVpcConfigDetails resourcesVpcConfig
The VPC configuration used by the cluster control plane.
String roleArn
The ARN of the IAM role that provides permissions for the Amazon EKS control plane to make calls to Amazon Web Services API operations on your behalf.
String version
The Amazon EKS server version for the cluster.
AwsEksClusterLoggingDetails logging
The logging configuration for the cluster.
List<E> securityGroupIds
The security groups that are associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Amazon EKS control plane.
List<E> subnetIds
The subnets that are associated with the cluster.
Boolean endpointPublicAccess
Indicates whether the Amazon EKS public API server endpoint is turned on. If the Amazon EKS public API server endpoint is turned off, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
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. Valid values are as follows:
Aborting
Launching
LinkingFrom
LinkingTo
Ready
Terminated
Terminating
Updating
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
OpenSearch version.
AwsElasticsearchDomainElasticsearchClusterConfigDetails elasticsearchClusterConfig
Information about an OpenSearch 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 OpenSearch 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 OpenSearch domain.
Valid values:
Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher
Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.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. A sample value is
m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled
must be true.
For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.
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.
For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.
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, OpenSearch allocates the cluster's nodes and replica index shards across Availability Zones in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
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 OpenSearch index logs publishing.
AwsElasticsearchDomainLogPublishingOptionsLogConfig searchSlowLogs
Configures the OpenSearch 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 OpenSearch 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. Valid values are as follows:
COMPLETED
ELIGIBLE
IN_PROGRESS
NOT_ELIGIBLE
PENDING_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.
List<E> additionalAttributes
Any additional attributes for a load balancer.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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.
List<E> loadBalancerAttributes
Attributes of the load balancer.
String arn
The Amazon Resource Name (ARN) of the endpoint.
String description
A description of the endpoint.
String endpointId
The URL subdomain of the endpoint. For example, if EndpointUrl is
https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is
abcde.veo.
String endpointUrl
The URL of the endpoint.
List<E> eventBuses
The event buses being used by the endpoint.
String name
The name of the endpoint.
AwsEventsEndpointReplicationConfigDetails replicationConfig
Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED,
which means you must supply a RoleArn. If you don't have a RoleArn or you don't want
event replication enabled, set the state to DISABLED.
String roleArn
The ARN of the role used by event replication for the endpoint.
AwsEventsEndpointRoutingConfigDetails routingConfig
The routing configuration of the endpoint.
String state
The current state of the endpoint.
String stateReason
The reason the endpoint is in its current state.
String eventBusArn
The Amazon Resource Name (ARN) of the event bus that the endpoint is associated with.
String state
The state of event replication.
AwsEventsEndpointRoutingConfigFailoverConfigDetails failoverConfig
The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails primary
The main Region of the endpoint.
AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails secondary
The Region that events are routed to when failover is triggered or event replication is enabled.
String healthCheck
The Amazon Resource Name (ARN) of the health check used by the endpoint to determine whether failover is triggered.
String route
Defines the secondary Region.
String status
Specifies whether CloudTrail is activated as a data source for the detector.
AwsGuardDutyDetectorDataSourcesCloudTrailDetails cloudTrail
An object that contains information on the status of CloudTrail as a data source for the detector.
AwsGuardDutyDetectorDataSourcesDnsLogsDetails dnsLogs
An object that contains information on the status of DNS logs as a data source for the detector.
AwsGuardDutyDetectorDataSourcesFlowLogsDetails flowLogs
An object that contains information on the status of VPC Flow Logs as a data source for the detector.
AwsGuardDutyDetectorDataSourcesKubernetesDetails kubernetes
An object that contains information on the status of Kubernetes data sources for the detector.
AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails malwareProtection
An object that contains information on the status of Malware Protection as a data source for the detector.
AwsGuardDutyDetectorDataSourcesS3LogsDetails s3Logs
An object that contains information on the status of S3 Data event logs as a data source for the detector.
String status
Describes whether DNS logs is enabled as a data source for the detector.
String status
Describes whether VPC Flow Logs are activated as a data source for the detector.
String status
Describes whether Kubernetes audit logs are activated as a data source for the detector.
AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails auditLogs
Describes whether Kubernetes audit logs are activated as a data source for the detector.
AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails scanEc2InstanceWithFindings
Describes the configuration of Malware Protection for EC2 instances with findings.
String serviceRole
The GuardDuty Malware Protection service role.
AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails ebsVolumes
Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.
String status
A value that describes whether S3 data event logs are automatically enabled for new members of an organization.
AwsGuardDutyDetectorDataSourcesDetails dataSources
Describes which data sources are activated for the detector.
List<E> features
Describes which features are activated for the detector.
String findingPublishingFrequency
The publishing frequency of the finding.
String serviceRole
The GuardDuty service role.
String status
The activation status of the detector.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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 name
The name of the Kinesis stream. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the stream name.
String arn
The Amazon Resource Name (ARN) of the Kinesis data stream.
AwsKinesisStreamStreamEncryptionDetails streamEncryption
When specified, enables or updates server-side encryption using an KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.
Integer shardCount
The number of shards that the stream uses.
Integer retentionPeriodHours
The number of hours for the data records that are stored in shards to remain accessible.
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, and date and time should be
separated by T. 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. Valid values are as follows:
Disabled
Enabled
PendingDeletion
PendingImport
Unavailable
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 KMS 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, and date and time should be
separated by T. 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.
List<E> architectures
The instruction set architecture that the function uses. Valid values are x86_64 or
arm64.
String packageType
The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a
container image and Zip for a .zip file archive.
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, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
AwsMskClusterClusterInfoClientAuthenticationSaslDetails sasl
Provides details for client authentication using SASL.
AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails unauthenticated
Provides details for allowing no client authentication.
AwsMskClusterClusterInfoClientAuthenticationTlsDetails tls
Provides details for client authentication using TLS.
AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails iam
Provides details for SASL client authentication using IAM.
AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails scram
Details for SASL client authentication using SCRAM.
Boolean enabled
Indicates whether SASL/IAM authentication is enabled or not.
Boolean enabled
Indicates whether SASL/SCRAM authentication is enabled or not.
List<E> certificateAuthorityArnList
List of Amazon Web Services Private CA Amazon Resource Names (ARNs). Amazon Web Services Private CA enables creation of private certificate authority (CA) hierarchies, including root and subordinate CAs, without the investment and maintenance costs of operating an on-premises CA.
Boolean enabled
Indicates whether TLS authentication is enabled or not.
Boolean enabled
Indicates whether unauthenticated is allowed or not.
AwsMskClusterClusterInfoEncryptionInfoDetails encryptionInfo
Includes encryption-related information, such as the KMS key used for encrypting data at rest and whether you want Amazon MSK to encrypt your data in transit.
String currentVersion
The current version of the MSK cluster.
Integer numberOfBrokerNodes
The number of broker nodes in the cluster.
String clusterName
The name of the cluster.
AwsMskClusterClusterInfoClientAuthenticationDetails clientAuthentication
Provides information for different modes of client authentication.
AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails encryptionInTransit
The settings for encrypting data in transit.
AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails encryptionAtRest
The data-volume encryption details. You can't update encryption at rest settings for existing clusters.
String dataVolumeKMSKeyId
The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
Boolean inCluster
When set to true, it indicates that data communication among the broker nodes of the cluster is
encrypted. When set to false, the communication happens in plain text. The default value is
true.
String clientBroker
Indicates the encryption setting for data in transit between clients and brokers.
AwsMskClusterClusterInfoDetails clusterInfo
Provides information about a cluster.
Boolean deleteProtection
Whether the firewall is protected from deletion. If set to true, then the firewall cannot be
deleted.
String description
A description of the firewall.
String firewallArn
The ARN of the firewall.
String firewallId
The identifier of the firewall.
String firewallName
A descriptive name of the firewall.
String firewallPolicyArn
The ARN of the firewall policy.
Boolean firewallPolicyChangeProtection
Whether the firewall is protected from a change to the firewall policy. If set to true, you cannot
associate a different policy with the firewall.
Boolean subnetChangeProtection
Whether the firewall is protected from a change to the subnet associations. If set to true, you
cannot map different subnets to the firewall.
List<E> subnetMappings
The public subnets that Network Firewall uses for the firewall. Each subnet must belong to a different Availability Zone.
String vpcId
The identifier of the VPC where the firewall is used.
FirewallPolicyDetails firewallPolicy
The firewall policy configuration.
String firewallPolicyArn
The ARN of the firewall policy.
String firewallPolicyId
The identifier of the firewall policy.
String firewallPolicyName
The name of the firewall policy.
String description
A description of the firewall policy.
String subnetId
The identifier of the subnet
Integer capacity
The maximum number of operating resources that this rule group can use.
String description
A description of the rule group.
RuleGroupDetails ruleGroup
Details about the rule group.
String ruleGroupArn
The ARN of the rule group.
String ruleGroupId
The identifier of the rule group.
String ruleGroupName
The descriptive name of the rule group.
String type
The type of rule group. A rule group can be stateful or stateless.
Boolean enabled
Enables fine-grained access control.
Boolean internalUserDatabaseEnabled
Enables the internal user database.
AwsOpenSearchServiceDomainMasterUserOptionsDetails masterUserOptions
Specifies information about the master user of the domain.
Integer instanceCount
The number of data nodes to use in the OpenSearch domain.
Boolean warmEnabled
Whether UltraWarm is enabled.
Integer warmCount
The number of UltraWarm instances.
Boolean dedicatedMasterEnabled
Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.
AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails zoneAwarenessConfig
Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.
Integer dedicatedMasterCount
The number of instances to use for the master node. If this attribute is specified, then
DedicatedMasterEnabled must be true.
String instanceType
The instance type for your data nodes.
For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.
String warmType
The type of UltraWarm instance.
Boolean zoneAwarenessEnabled
Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
String dedicatedMasterType
The hardware configuration of the computer that hosts the dedicated master node.
If this attribute is specified, then DedicatedMasterEnabled must be true.
Integer availabilityZoneCount
The number of Availability Zones that the domain uses. Valid values are 2 or 3. The
default is 2.
String arn
The ARN of the OpenSearch Service domain.
String accessPolicies
IAM policy document that specifies the access policies for the OpenSearch Service domain.
String domainName
The name of the endpoint.
String id
The identifier of the domain.
String domainEndpoint
The domain endpoint.
String engineVersion
The version of the domain engine.
AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails encryptionAtRestOptions
Details about the configuration for encryption at rest.
AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails nodeToNodeEncryptionOptions
Details about the configuration for node-to-node encryption.
AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails serviceSoftwareOptions
Information about the status of a domain relative to the latest service software.
AwsOpenSearchServiceDomainClusterConfigDetails clusterConfig
Details about the configuration of an OpenSearch cluster.
AwsOpenSearchServiceDomainDomainEndpointOptionsDetails domainEndpointOptions
Additional options for the domain endpoint.
AwsOpenSearchServiceDomainVpcOptionsDetails vpcOptions
Information that OpenSearch Service derives based on VPCOptions for the domain.
AwsOpenSearchServiceDomainLogPublishingOptionsDetails logPublishingOptions
Configures the CloudWatch Logs to publish for the OpenSearch domain.
Map<K,V> domainEndpoints
The domain endpoints. Used if the OpenSearch domain resides in a VPC.
This is a map of key-value pairs. The key is always vpc. The value is the endpoint.
AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails advancedSecurityOptions
Specifies options for fine-grained access control.
String customEndpointCertificateArn
The ARN for the security certificate. The certificate is managed in ACM.
Boolean customEndpointEnabled
Whether to enable a custom endpoint for the domain.
Boolean enforceHTTPS
Whether to require that all traffic to the domain arrive over HTTPS.
String customEndpoint
The fully qualified URL for the custom endpoint.
String tLSSecurityPolicy
The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain.
AwsOpenSearchServiceDomainLogPublishingOption indexSlowLogs
Configures the OpenSearch index logs publishing.
AwsOpenSearchServiceDomainLogPublishingOption searchSlowLogs
Configures the OpenSearch search slow log publishing.
AwsOpenSearchServiceDomainLogPublishingOption auditLogs
Configures the OpenSearch audit logs publishing.
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, OpenSearch 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. Valid values are as follows:
COMPLETED
ELIGIBLE
IN_PROGRESS
NOT_ELIGIBLE
PENDING_UPDATE
Boolean optionalDeployment
Whether the service software update is optional.
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. Valid values are as follows:
aurora
aurora-mysql
aurora-postgresql
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, and date and time should be
separated by T. 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.Valid values are as follows:
global
multimaster
parallelquery
provisioned
serverless
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. Valid values are as follows:
started
starting
stopped
stopping
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 autoMinorVersionUpgrade
Indicates if minor version upgrades are automatically applied to the cluster.
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.
String attributeName
The name of the manual DB cluster snapshot attribute. The attribute named restore refers to the list
of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot.
List<E> attributeValues
The value(s) for the manual DB cluster snapshot attribute. If the AttributeName field is set to
restore, then this element returns a list of IDs of the Amazon Web Services accounts that are
authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then
the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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.
List<E> dbClusterSnapshotAttributes
Contains the name and values of a manual DB cluster snapshot attribute.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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 dbSecurityGroupArn
The ARN for the DB security group.
String dbSecurityGroupDescription
Provides the description of the DB security group.
String dbSecurityGroupName
Specifies the name of the DB security group.
List<E> ec2SecurityGroups
Contains a list of EC2 security groups.
List<E> ipRanges
Contains a list of IP ranges.
String ownerId
Provides the Amazon Web Services ID of the owner of a specific DB security group.
String vpcId
Provides VPC ID associated with the DB security group.
String ec2SecurityGroupId
Specifies the ID for the EC2 security group.
String ec2SecurityGroupName
Specifies the name of the EC2 security group.
String ec2SecurityGroupOwnerId
Provides the Amazon Web Services ID of the owner of the EC2 security group.
String status
Provides the status of the EC2 security group.
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. Valid values are as follows:
aurora
aurora-mysql
aurora-postgresql
c
mariadb
mysql
oracle-ee
oracle-se
oracle-se1
oracle-se2
sqlserver-ee
sqlserver-ex
sqlserver-se
sqlserver-web
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. Valid values are as follows:
gp2
io1
standard
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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.
AwsRedshiftClusterLoggingStatus loggingStatus
Information about the logging status of the cluster.
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
String bucketName
The name of the S3 bucket where the log files are stored.
String lastFailureMessage
The message indicating that the logs failed to be delivered.
String lastFailureTime
The last time when logs failed to be delivered.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
String lastSuccessfulDeliveryTime
The last time that logs were delivered successfully.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
Boolean loggingEnabled
Indicates whether logging is enabled.
String s3KeyPrefix
Provides the prefix applied to the log file names.
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
String comment
Any comments that you include about the hosted zone.
AwsRoute53HostedZoneObjectDetails hostedZone
An object that contains information about the specified hosted zone.
List<E> vpcs
An object that contains information about the Amazon Virtual Private Clouds (Amazon VPCs) that are associated with the specified hosted zone.
List<E> nameServers
An object that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.
AwsRoute53QueryLoggingConfigDetails queryLoggingConfig
An array that contains one QueryLoggingConfig element for each DNS query logging configuration that
is associated with the current Amazon Web Services account.
String id
The ID that Route 53 assigns to the hosted zone when you create it.
String name
The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
AwsRoute53HostedZoneConfigDetails config
An object that includes the Comment element.
CloudWatchLogsLogGroupArnConfigDetails cloudWatchLogsLogGroupArn
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that Route 53 is publishing logs to.
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, and date and time should be
separated by T. 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. Valid values are
LifecycleAndOperator or LifecycleOrOperator.
String prefix
Prefix text for matching objects.
AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails tag
A tag that is assigned to matching objects.
String type
The type of filter value. Valid values are LifecyclePrefixPredicate or
LifecycleTagPredicate.
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, and date and time should be
separated by T. 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. Valid values are as follows:
DEEP_ARCHIVE
GLACIER
INTELLIGENT_TIERING
ONEZONE_IA
STANDARD_IA
Boolean isMfaDeleteEnabled
Specifies whether MFA delete is currently enabled in the S3 bucket versioning configuration. If the S3 bucket was never configured with MFA delete, then this attribute is not included.
String status
The versioning status of the S3 bucket. Valid values are Enabled or Suspended.
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 ownerAccountId
The Amazon Web Services account identifier of the account that owns 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, and date and time should be
separated by T. 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.
AwsS3BucketBucketVersioningConfiguration bucketVersioningConfiguration
The versioning state of an S3 bucket.
AwsS3BucketObjectLockConfiguration objectLockConfiguration
Specifies which rule Amazon S3 applies by default to every new object placed in the specified 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, with corresponding valid values as follows:
LambdaConfiguration
QueueConfiguration
TopicConfiguration
AwsS3BucketNotificationConfigurationS3KeyFilter s3KeyFilter
Details for an Amazon S3 filter.
String objectLockEnabled
Indicates whether the bucket has an Object Lock configuration enabled.
AwsS3BucketObjectLockConfigurationRuleDetails rule
Specifies the Object Lock rule for the specified object.
Integer days
The number of days that you want to specify for the default retention period.
String mode
The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.
Integer years
The number of years that you want to specify for the default retention period.
AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails defaultRetention
The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket.
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, and date and time should be
separated by T. 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.
List<E> acceleratorTypes
A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
List<E> additionalCodeRepositories
An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.
String defaultCodeRepository
The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.
String directInternetAccess
Sets whether SageMaker provides internet access to the notebook instance. If you set this to
Disabled, this notebook instance is able to access resources only in your VPC, and is not be able to
connect to SageMaker training and endpoint services unless you configure a Network Address Translation (NAT)
Gateway in your VPC.
String failureReason
If status of the instance is Failed, the reason it failed.
AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails instanceMetadataServiceConfiguration
Information on the IMDS configuration of the notebook instance.
String instanceType
The type of machine learning (ML) compute instance to launch for the notebook instance.
String kmsKeyId
The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and disabling keys in the Key Management Service Developer Guide.
String networkInterfaceId
The network interface ID that SageMaker created when the instance was created.
String notebookInstanceArn
The Amazon Resource Name (ARN) of the notebook instance.
String notebookInstanceLifecycleConfigName
The name of a notebook instance lifecycle configuration.
String notebookInstanceName
The name of the new notebook instance.
String notebookInstanceStatus
The status of the notebook instance.
String platformIdentifier
The platform identifier of the notebook instance runtime environment.
String roleArn
The Amazon Resource Name (ARN) of the IAM role associated with the instance.
String rootAccess
Whether root access is enabled or disabled for users of the notebook instance.
List<E> securityGroups
The VPC security group IDs.
String subnetId
The ID of the VPC subnet to which you have a connectivity from your ML compute instance.
String url
The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
Integer volumeSizeInGB
The size, in GB, of the ML storage volume to attach to the notebook instance.
String minimumInstanceMetadataServiceVersion
Indicates the minimum IMDS version that the notebook instance supports.
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 this attribute with
BatchImportFindings or BatchUpdateFindings. The exception to this is a custom
integration.
When you use the Security Hub console or API to filter findings by product name, you use this attribute.
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 update this attribute with
BatchImportFindings or BatchUpdateFindings. The exception to this is a custom
integration.
When you use the Security Hub console or API to filter findings by company name, you use this attribute.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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> threats
Details about the threat detected in a security finding and the file paths that were affected by the threat.
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.
Boolean sample
Indicates whether the finding is a sample finding.
GeneratorDetails generatorDetails
Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to findings that relate to Lambda functions. Amazon Inspector identifies policy violations and vulnerabilities in Lambda function code based on internal detectors developed in collaboration with Amazon CodeGuru. Security Hub receives those findings.
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.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
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.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
List<E> createdAt
An ISO8601-formatted timestamp that indicates when the security findings provider captured the potential security issue that a finding captured.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
List<E> updatedAt
An ISO8601-formatted timestamp that indicates when the security findings provider last updated the finding record.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
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.
List<E> companyName
The name of the findings provider (company) that owns the solution (product) that generates findings.
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. This field accepts positive integers between O and 2147483647.
List<E> processLaunchedAt
A timestamp that identifies when the process was launched.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
List<E> processTerminatedAt
A timestamp that identifies when the process was terminated.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
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
A timestamp that identifies 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
A timestamp that identifies when the container was started.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
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:
RecordState changes from ARCHIVED to ACTIVE.
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.
If one of the following occurs, the workflow status is changed automatically from NOTIFIED to
NEW:
RecordState changes from ARCHIVED to ACTIVE.
Compliance.Status changes from PASSED to FAILED, WARNING, or
NOT_AVAILABLE.
SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed.
The workflow status of a SUPPRESSED finding does not change if RecordState changes from
ARCHIVED to ACTIVE.
RESOLVED - The finding was reviewed and remediated and is now considered resolved.
The finding remains RESOLVED unless one of the following occurs:
RecordState changes from ARCHIVED to ACTIVE.
Compliance.Status changes from PASSED to FAILED, WARNING, or
NOT_AVAILABLE.
In those cases, the workflow status is automatically reset to NEW.
For findings from controls, if Compliance.Status is PASSED, then Security Hub
automatically sets the workflow status to 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
List<E> sample
Indicates whether or not sample findings are included in the filter results.
List<E> complianceSecurityControlId
The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Service and a number, such as APIGateway.5.
List<E> complianceAssociatedStandardsId
The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.
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 Amazon SNS topic.
String topicName
The name of the Amazon SNS topic.
String owner
The subscription's owner.
String sqsSuccessFeedbackRoleArn
Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
String sqsFailureFeedbackRoleArn
Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
String applicationSuccessFeedbackRoleArn
Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
String firehoseSuccessFeedbackRoleArn
Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
String firehoseFailureFeedbackRoleArn
Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
String httpSuccessFeedbackRoleArn
Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
String httpFailureFeedbackRoleArn
Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
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. Valid values are as follows:
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. Valid values are as follows:
CRITICAL
HIGH
MEDIUM
LOW
INFORMATIONAL
UNSPECIFIED
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 label
A user-defined or an auto-generated string that identifies a Map state. This parameter is present
only if the stateMachineArn specified in input is a qualified state machine ARN.
AwsStepFunctionStateMachineLoggingConfigurationDetails loggingConfiguration
Used to set CloudWatch Logs options.
String name
The name of the state machine.
String roleArn
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
String stateMachineArn
The ARN that identifies the state machine.
String status
The current status of the state machine.
AwsStepFunctionStateMachineTracingConfigurationDetails tracingConfiguration
Specifies whether X-Ray tracing is enabled.
String type
The type of the state machine (STANDARD or EXPRESS).
String logGroupArn
The ARN (ends with :*) of the CloudWatch Logs log group to which you want your logs emitted.
AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails cloudWatchLogsLogGroup
An object describing a CloudWatch Logs log group. For more information, see Amazon Web Services::Logs::LogGroup in the CloudFormation User Guide.
List<E> destinations
An array of objects that describes where your execution history events will be logged.
Boolean includeExecutionData
Determines whether execution data is included in your log. When set to false, data is excluded.
String level
Defines which category of execution history events are logged.
Boolean enabled
When set to true, X-Ray tracing is enabled.
String metricName
The name of the metrics for the rate-based rule.
String name
The name of the rate-based rule.
String rateKey
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
Long rateLimit
The maximum number of requests that have an identical value for the field specified in RateKey that
are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other
predicates specified in the rule are met, WAF triggers the action for the rule.
String ruleId
The unique identifier for the rate-based rule.
List<E> matchPredicates
The predicates to include in the rate-based rule.
String dataId
The unique identifier for the predicate.
Boolean negated
If set to true, then the rule actions are performed on requests that match the predicate settings.
If set to false, then the rule actions are performed on all requests except those that match the
predicate settings.
String type
The type of predicate. Valid values are as follows:
ByteMatch
GeoMatch
IPMatch
RegexMatch
SizeConstraint
SqlInjectionMatch
XssMatch
String metricName
The name of the metrics for the rate-based rule.
String name
The name of the rate-based rule.
String rateKey
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
Long rateLimit
The maximum number of requests that have an identical value for the field specified in RateKey that
are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other
predicates specified in the rule are met, WAF triggers the action for the rule.
String ruleId
The unique identifier for the rate-based rule.
List<E> matchPredicates
The predicates to include in the rate-based rule.
String dataId
The unique identifier for the predicate.
Boolean negated
If set to true, then the rule actions are performed on requests that match the predicate settings.
If set to false, then the rule actions are performed on all requests except those that match the
predicate settings.
String type
The type of predicate. Valid values are as follows:
ByteMatch
GeoMatch
IPMatch
RegexMatch
SizeConstraint
SqlInjectionMatch
XssMatch
String metricName
A name for the metrics for the rule.
String name
A descriptive name for the rule.
List<E> predicateList
Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet,
XssMatchSet, RegexMatchSet, GeoMatchSet, and
SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you
want to negate the settings.
String ruleId
The ID of the rule.
String metricName
A name for the metrics for this rule group.
String name
The descriptive name of the rule group.
String ruleGroupId
The ID of the rule group.
List<E> rules
Provides information about the rule statements used to identify the web requests that you want to allow, block, or count.
String type
Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet,
XssMatchSet, RegexMatchSet, GeoMatchSet, and
SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you
want to negate the settings.
AwsWafRegionalRuleGroupRulesActionDetails action
The action that WAF should take on a web request when it matches the criteria defined in the rule.
Integer priority
If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order based on the
value of Priority.
String ruleId
The ID for a rule.
String type
The type of rule in the rule group.
String dataId
A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.
Boolean negated
Specifies if you want WAF to allow, block, or count requests based on the settings in the
ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet,
RegexMatchSet, GeoMatchSet, or SizeConstraintSet.
String type
The type of predicate in a rule, such as ByteMatch or IPSet.
String defaultAction
The action to perform if none of the rules contained in the web ACL match.
String metricName
A name for the metrics for this web ACL.
String name
A descriptive name for the web ACL.
List<E> rulesList
An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of the rule.
String webAclId
The ID of the web ACL.
String type
For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.
AwsWafRegionalWebAclRulesListActionDetails action
The action that WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request.
AwsWafRegionalWebAclRulesListOverrideActionDetails overrideAction
Overrides the rule evaluation result in the rule group.
Integer priority
The order in which WAF evaluates the rules in a web ACL.
String ruleId
The ID of an WAF Regional rule to associate with a web ACL.
String type
For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.
String type
Overrides the rule evaluation result in the rule group.
String metricName
The name of the metrics for this rule.
String name
A descriptive name for the rule.
List<E> predicateList
Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet,
XssMatchSet, RegexMatchSet, GeoMatchSet, and
SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you
want to negate the settings.
String ruleId
The ID of the WAF rule.
String metricName
The name of the metrics for this rule group.
String name
The name of the rule group.
String ruleGroupId
The ID of the rule group.
List<E> rules
Provides information about the rules attached to the rule group. These rules identify the web requests that you want to allow, block, or count.
String type
The action that WAF should take on a web request when it matches the rule's statement.
AwsWafRuleGroupRulesActionDetails action
Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.
Integer priority
If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order based on the
value of Priority.
String ruleId
The rule ID for a rule.
String type
The type of rule.
String dataId
A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.
Boolean negated
Specifies if you want WAF to allow, block, or count requests based on the settings in the
ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet,
RegexMatchSet, GeoMatchSet, or SizeConstraintSet.
String type
The type of predicate in a rule, such as ByteMatch or IPSet.
AwsWafv2CustomRequestHandlingDetails customRequestHandling
Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide..
AwsWafv2CustomResponseDetails customResponse
Defines a custom response for the web request. For information, see Customizing web requests and responses in WAF in the WAF Developer Guide..
String customResponseBodyKey
References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block.
Integer responseCode
The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.
List<E> responseHeaders
The HTTP headers to use in the response.
Long capacity
The web ACL capacity units (WCUs) required for this rule group.
String description
A description of the rule group that helps with identification.
String id
A unique identifier for the rule group.
String name
The name of the rule group. You cannot change the name of a rule group after you create it.
String arn
The Amazon Resource Name (ARN) of the entity.
List<E> rules
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
String scope
Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
AwsWafv2VisibilityConfigDetails visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
AwsWafv2CustomRequestHandlingDetails customRequestHandling
Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired. For more information, see Customizing web requests and responses in WAF in the WAF Developer Guide..
AwsWafv2CustomRequestHandlingDetails customRequestHandling
Defines custom handling for the web request. For more information, see Customizing web requests and responses in WAF in the WAF Developer Guide..
AwsWafv2ActionAllowDetails allow
Instructs WAF to allow the web request.
AwsWafv2ActionBlockDetails block
Instructs WAF to block the web request.
AwsWafv2RulesActionCaptchaDetails captcha
Instructs WAF to run a CAPTCHA check against the web request.
AwsWafv2RulesActionCountDetails count
Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
AwsWafv2RulesActionDetails action
The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
String name
The name of the rule.
String overrideAction
The action to use in the place of the action that results from the rule group evaluation.
Integer priority
If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the
value of Priority. WAF processes rules with lower priority first. The priorities don't need to be
consecutive, but they must all be different.
AwsWafv2VisibilityConfigDetails visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Boolean cloudWatchMetricsEnabled
A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF metrics and dimensions in the WAF Developer Guide.
String metricName
A name of the Amazon CloudWatch metric.
Boolean sampledRequestsEnabled
A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
AwsWafv2ActionAllowDetails allow
Specifies that WAF should allow requests by default.
AwsWafv2ActionBlockDetails block
Specifies that WAF should block requests by default.
AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails immunityTimeProperty
Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.
Long immunityTime
The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF.
String name
The name of the web ACL.
String arn
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
Boolean managedbyFirewallManager
Indicates whether this web ACL is managed by Firewall Manager.
String id
A unique identifier for the web ACL.
Long capacity
The web ACL capacity units (WCUs) currently being used by this web ACL.
AwsWafv2WebAclCaptchaConfigDetails captchaConfig
Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
CaptchaConfig settings.
AwsWafv2WebAclActionDetails defaultAction
The action to perform if none of the Rules contained in the web ACL match.
String description
A description of the web ACL that helps with identification.
List<E> rules
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
AwsWafv2VisibilityConfigDetails visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
String name
A friendly name or description of the web ACL. You can't change the name of a web ACL after you create it.
String defaultAction
The action to perform if none of the rules contained in the web ACL match.
List<E> rules
An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of the rule.
String webAclId
A unique identifier for a web ACL.
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 web ACL. 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 web ACL 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 web ACL, 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.
String keyId
The identifier of the KMS key that is used for encryption. Provided if Type is KMS.
String status
The current status of the encryption configuration. Valid values are ACTIVE or UPDATING
.
When Status is equal to UPDATING, X-Ray might use both the old and new encryption.
String type
The type of encryption. KMS indicates that the encryption uses KMS keys. NONE indicates
the default encryption.
List<E> processedAutomationRules
A list of properly processed rule ARNs.
List<E> unprocessedAutomationRules
A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This
parameter tells you which automation rules the request didn't delete and why.
List<E> securityControls
An array that returns the identifier, Amazon Resource Name (ARN), and other details about a security control. The
same information is returned whether the request includes SecurityControlId or
SecurityControlArn.
List<E> unprocessedIds
A security control (identified with SecurityControlId, SecurityControlArn, or a mix of
both parameters) for which details cannot be returned.
List<E> standardsControlAssociationIds
An array with one or more objects that includes a security control (identified with
SecurityControlId, SecurityControlArn, or a mix of both parameters) and the Amazon
Resource Name (ARN) of a standard. This field is used to query the enablement status of a control in a specified
standard. The security control ID or ARN is the same across standards.
List<E> standardsControlAssociationDetails
Provides the enablement status of a security control in a specified standard and other details for the control in relation to the specified standard.
List<E> unprocessedAssociations
A security control (identified with SecurityControlId, SecurityControlArn, or a mix of
both parameters) whose enablement status in a specified standard cannot be returned.
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> processedAutomationRules
A list of properly processed rule ARNs.
List<E> unprocessedAutomationRules
A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This
parameter tells you which automation rules the request didn't update and why.
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. Possible values are:
ConcurrentUpdateError - Another request attempted to update the finding while this request was being
processed. This error may also occur if you call
BatchUpdateFindings and
BatchImportFindings at the same time.
DuplicatedFindingIdentifier - The request included two or more findings with the same
FindingIdentifier.
FindingNotFound - The FindingIdentifier included in the request did not match an
existing finding.
FindingSizeExceeded - The finding size was greater than the permissible value of 240 KB.
InternalFailure - An internal service failure occurred when updating the finding.
InvalidInput - The finding update contained an invalid value that did not satisfy the Amazon Web
Services Security Finding Format syntax.
String errorMessage
The message associated with the error. Possible values are:
Concurrent finding updates detected
Finding Identifier is duplicated
Finding Not Found
Finding size exceeded 240 KB
Internal service failure
Invalid Input
Boolean value
The value of the boolean.
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.
Integer endLine
The line number of the last line of code in which the vulnerability is located.
String fileName
The name of the file in which the code vulnerability is located.
String filePath
The file path to the code in which the vulnerability is located.
Integer startLine
The line number of the first line of code in which the vulnerability is located.
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 securityControlId
The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Service and a number, such as APIGateway.5.
List<E> associatedStandards
The enabled security standards in which a security control is currently enabled.
String containerRuntime
The runtime of the container.
String name
The name of the container related to a finding.
String imageId
The identifier of the container image related to a finding.
String imageName
The name of the container 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, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
List<E> volumeMounts
Provides information about the mounting of a volume in a container.
Boolean privileged
When this parameter is true, the container is given elevated privileges on the host container
instance (similar to the root user).
String actionTargetArn
The Amazon Resource Name (ARN) for the custom action target.
Map<K,V> tags
User-defined tags that help you label the purpose of a rule.
String ruleStatus
Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub
starts applying the rule to findings and finding updates after the rule is created. To change the value of this
parameter after creating a rule, use
BatchUpdateAutomationRules .
Integer ruleOrder
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
String ruleName
The name of the rule.
String description
A description of the rule.
Boolean isTerminal
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
AutomationRulesFindingFilters criteria
A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.
List<E> actions
One or more actions to update finding fields if a finding matches the conditions specified in
Criteria.
String ruleArn
The Amazon Resource Name (ARN) of the automation rule that you created.
String regionLinkingMode
Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
The selected option also determines how to use the Regions provided in the Regions list.
The options are as follows:
ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled.
When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub
supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where
Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose
this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them
and you opt into them.
SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the
Regions parameter. Security Hub does not automatically aggregate findings from new Regions.
List<E> regions
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated
list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of
Regions that do aggregate findings to the aggregation Region.
String findingAggregatorArn
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.
String findingAggregationRegion
The aggregation Region.
String regionLinkingMode
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
List<E> regions
The list of excluded Regions or included Regions.
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 start
A timestamp that provides the start date for the date filter.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
String end
A timestamp that provides the end date for the date filter.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
DateRange dateRange
A date range for the date filter.
String actionTargetArn
The Amazon Resource Name (ARN) of the custom action target to delete.
String actionTargetArn
The ARN of the custom action target that was deleted.
String findingAggregatorArn
The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.
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.
String controlFindingGenerator
Specifies whether the calling account has consolidated control findings turned on. If the value for this field is
set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the
check applies to multiple enabled standards.
If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for
a control check when the check applies to multiple enabled standards.
The value for this field in a member account matches the value in the administrator account. For accounts that
aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled
Security Hub on or after February 23, 2023.
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 autoEnableStandards
Whether to automatically enable Security Hub default standards for new member accounts in the organization.
The default value of this parameter is equal to DEFAULT.
If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member
accounts. If equal to NONE, then default standards are not automatically enabled for new member
accounts.
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.
String controlFindingGenerator
This field, used when enabling Security Hub, specifies whether the calling account has consolidated control
findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a
single finding for a control check even when the check applies to multiple enabled standards.
If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for
a control check when the check applies to multiple enabled standards.
The value for this field in a member account matches the value in the administrator account. For accounts that
aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled
Security Hub on or after February 23, 2023.
String filePath
Path to the infected or suspicious file on the resource it was detected on.
String fileName
The name of the infected or suspicious file corresponding to the hash.
String resourceId
The Amazon Resource Name (ARN) of the resource on which the threat was detected.
String hash
The hash value for the infected or suspicious file.
String findingAggregatorArn
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.
AwsSecurityFindingIdentifier findingIdentifier
Date updateTime
An ISO 8601-formatted timestamp that indicates when Security Hub processed the updated finding record.
A correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date
and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
Boolean findingCreated
Identifies whether the event marks the creation of a new finding. A value of True means that the
finding is newly created. A value of False means that the finding isn’t newly created.
FindingHistoryUpdateSource updateSource
Identifies the source of the event that changed the finding. For example, an integrated Amazon Web Service or
third-party partner integration may call
BatchImportFindings , or an Security Hub customer may call
BatchUpdateFindings .
List<E> updates
An array of objects that provides details about the finding change event, including the Amazon Web Services Security Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after the change.
String nextToken
A token for pagination purposes. Provide this token in the subsequent request to
GetFindingsHistory to get up to an additional 100 results of history for the same finding that
you specified in your initial request.
String updatedField
The ASFF field that changed during the finding change event.
String oldValue
The value of the ASFF field before the finding change event.
String newValue
The value of the ASFF field after the finding change event. To preserve storage and readability, Security Hub
omits this value if
FindingHistoryRecord exceeds database limits.
String type
Describes the type of finding change event, such as a call to
BatchImportFindings (by an integrated Amazon Web Service or third party partner integration) or
BatchUpdateFindings (by a Security Hub customer).
String identity
The identity of the source that initiated the finding change event. For example, the Amazon Resource Name (ARN) of a partner that calls BatchImportFindings or of a customer that calls BatchUpdateFindings.
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
List<E> statefulRuleGroupReferences
The stateful rule groups that are used in the firewall policy.
List<E> statelessCustomActions
The custom action definitions that are available to use in the firewall policy's
StatelessDefaultActions setting.
List<E> statelessDefaultActions
The actions to take on a packet if it doesn't match any of the stateless rules in the policy.
You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe
), and can optionally include a custom action from StatelessCustomActions.
List<E> statelessFragmentDefaultActions
The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.
You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe
), and can optionally include a custom action from StatelessCustomActions.
List<E> statelessRuleGroupReferences
The stateless rule groups that are used in the firewall policy.
String resourceArn
The ARN of the stateful rule group.
StatelessCustomActionDefinition actionDefinition
The definition of the custom action.
String actionName
The name of the custom action.
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.
String findingAggregatorArn
The ARN of the finding aggregator to return details for. To obtain the ARN, use
ListFindingAggregators.
String findingAggregatorArn
The ARN of the finding aggregator.
String findingAggregationRegion
The aggregation Region.
String regionLinkingMode
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
List<E> regions
The list of excluded Regions or included Regions.
AwsSecurityFindingIdentifier findingIdentifier
Date startTime
An ISO 8601-formatted timestamp that indicates the start time of the requested finding history. A correctly
formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time
should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
If you provide values for both StartTime and EndTime, Security Hub returns finding
history for the specified time period. If you provide a value for StartTime but not for
EndTime, Security Hub returns finding history from the StartTime to the time at which
the API is called. If you provide a value for EndTime but not for StartTime, Security
Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you provide neither
StartTime nor EndTime, Security Hub returns finding history from the CreatedAt
timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is
limited to 100 results, and the maximum time period is limited to 90 days.
Date endTime
An ISO 8601-formatted timestamp that indicates the end time of the requested finding history. A correctly
formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time
should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
If you provide values for both StartTime and EndTime, Security Hub returns finding
history for the specified time period. If you provide a value for StartTime but not for
EndTime, Security Hub returns finding history from the StartTime to the time at which
the API is called. If you provide a value for EndTime but not for StartTime, Security
Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you provide neither
StartTime nor EndTime, Security Hub returns finding history from the CreatedAt
timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is
limited to 100 results, and the maximum time period is limited to 90 days.
String nextToken
A token for pagination purposes. Provide NULL as the initial value. In subsequent requests, provide
the token included in the response to get up to an additional 100 results of finding history. If you don’t
provide NextToken, Security Hub returns up to 100 results of finding history for each request.
Integer maxResults
The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.
List<E> records
A list of events that altered the specified finding during the specified time period.
String nextToken
A token for pagination purposes. Provide this token in the subsequent request to GetFindingsHistory
to get up to an additional 100 results of history for the same finding that you specified in your initial
request.
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 associationId
The association ID for the IPv6 CIDR block.
String ipv6CidrBlock
The IPv6 CIDR block.
String cidrBlockState
Information about the state of the CIDR block. Valid values are as follows:
associating
associated
disassociating
disassociated
failed
failing
String value
A value for the keyword.
String code
String nextToken
A token to specify where to start paginating the response. This is the NextToken from a previously
truncated response. On your first call to the ListAutomationRules API, set the value of this
parameter to NULL.
Integer maxResults
The maximum number of rules to return in the response. This currently ranges from 1 to 100.
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.
List<E> findingAggregators
The list of finding aggregators. This operation currently only returns a single result.
String nextToken
If there are more results, this is the token to provide in the next call to ListFindingAggregators.
This operation currently only returns a single result.
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 standardsArn
The Amazon Resource Name (ARN) of the standard that you want to view controls for.
String nextToken
Optional pagination parameter.
Integer maxResults
An optional parameter that limits the total results of the API response to the specified number. If this
parameter isn't provided in the request, the results include the first 25 security controls that apply to the
specified standard. The results also include a NextToken parameter that you can use in a subsequent
API call to get the next 25 controls. This repeats until all controls for the standard are returned.
String securityControlId
The identifier of the control (identified with SecurityControlId, SecurityControlArn,
or a mix of both parameters) that you want to determine the enablement status of in each enabled standard.
String nextToken
Optional pagination parameter.
Integer maxResults
An optional parameter that limits the total results of the API response to the specified number. If this
parameter isn't provided in the request, the results include the first 25 standard and control associations. The
results also include a NextToken parameter that you can use in a subsequent API call to get the next
25 associations. This repeats until all associations for the specified control are returned. The number of
results is limited by the number of supported Security Hub standards that you've enabled in the calling account.
List<E> standardsControlAssociationSummaries
An array that provides the enablement status and other details for each security control that applies to each enabled standard.
String nextToken
A pagination parameter that's included in the response only if it was included in the request.
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's no match.
String comparison
The condition to apply to the key value when filtering Security Hub findings with a map filter.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use CONTAINS. For example, for the
ResourceTags field, the filter Department CONTAINS Security matches findings that
include the value Security for the Department tag. In the same example, a finding with
a value of Security team for the Department tag is a match.
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 Department tag.
CONTAINS and EQUALS filters on the same field are joined by OR. A finding
matches if it matches any one of those filters. For example, the filters
Department CONTAINS Security OR Department CONTAINS Finance match a finding that includes either
Security, Finance, or both values.
To search for values that don't have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use NOT_CONTAINS. For example, for the
ResourceTags field, the filter Department NOT_CONTAINS Finance matches findings that
exclude the value Finance for the Department tag.
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
don’t have the value Finance for the Department tag.
NOT_CONTAINS and NOT_EQUALS filters on the same field are joined by AND. A
finding matches only if it matches all of those filters. For example, the filters
Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance match a finding that excludes
both the Security and Finance values.
CONTAINS filters can only be used with other CONTAINS filters.
NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.
You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field.
Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS filter on the same
field. Combining filters in this way returns an error.
CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more
information, see Automation rules in the
Security Hub User Guide.
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.
AccountSuspended - 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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. This field accepts positive integers between O and 2147483647.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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.
String gatewayId
The ID of the virtual private gateway.
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 Amazon EC2 volume.
AwsEc2VpcDetails awsEc2Vpc
Details for an Amazon 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 web ACL.
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 Amazon ECS cluster.
AwsEcsContainerDetails awsEcsContainer
Provides information about a Docker container that's part of a task.
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 Amazon EC2 VPN connection.
AwsEcrContainerImageDetails awsEcrContainerImage
Information about an Amazon ECR image.
AwsOpenSearchServiceDomainDetails awsOpenSearchServiceDomain
Details about an Amazon OpenSearch Service domain.
AwsEc2VpcEndpointServiceDetails awsEc2VpcEndpointService
Details about the service configuration for a VPC endpoint service.
AwsXrayEncryptionConfigDetails awsXrayEncryptionConfig
Information about the encryption configuration for X-Ray.
AwsWafRateBasedRuleDetails awsWafRateBasedRule
Details about a rate-based rule for global resources.
AwsWafRegionalRateBasedRuleDetails awsWafRegionalRateBasedRule
Details about a rate-based rule for Regional resources.
AwsEcrRepositoryDetails awsEcrRepository
Information about an Amazon Elastic Container Registry repository.
AwsEksClusterDetails awsEksCluster
Details about an Amazon EKS cluster.
AwsNetworkFirewallFirewallPolicyDetails awsNetworkFirewallFirewallPolicy
Details about an Network Firewall firewall policy.
AwsNetworkFirewallFirewallDetails awsNetworkFirewallFirewall
Details about an Network Firewall firewall.
AwsNetworkFirewallRuleGroupDetails awsNetworkFirewallRuleGroup
Details about an Network Firewall rule group.
AwsRdsDbSecurityGroupDetails awsRdsDbSecurityGroup
Details about an Amazon RDS DB security group.
AwsKinesisStreamDetails awsKinesisStream
Details about an Amazon Kinesis data stream.
AwsEc2TransitGatewayDetails awsEc2TransitGateway
Details about an Amazon EC2 transit gateway that interconnects your virtual private clouds (VPC) and on-premises networks.
AwsEfsAccessPointDetails awsEfsAccessPoint
Details about an Amazon EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point.
AwsCloudFormationStackDetails awsCloudFormationStack
Details about an CloudFormation stack. A stack is a collection of Amazon Web Services resources that you can manage as a single unit.
AwsCloudWatchAlarmDetails awsCloudWatchAlarm
Details about an Amazon CloudWatch alarm. An alarm allows you to monitor and receive alerts about your Amazon Web Services resources and applications across multiple Regions.
AwsEc2VpcPeeringConnectionDetails awsEc2VpcPeeringConnection
Details about an Amazon EC2 VPC peering connection. A VPC peering connection is a networking connection between two VPCs that enables you to route traffic between them privately.
AwsWafRegionalRuleGroupDetails awsWafRegionalRuleGroup
Details about an WAF rule group for Regional resources.
AwsWafRegionalRuleDetails awsWafRegionalRule
Details about an WAF rule for Regional resources.
AwsWafRegionalWebAclDetails awsWafRegionalWebAcl
Details about an WAF web access control list (web ACL) for Regional resources.
AwsWafRuleDetails awsWafRule
Details about an WAF rule for global resources.
AwsWafRuleGroupDetails awsWafRuleGroup
Details about an WAF rule group for global resources.
AwsEcsTaskDetails awsEcsTask
Details about a task in a cluster.
AwsBackupBackupVaultDetails awsBackupBackupVault
Provides details about an Backup backup vault.
AwsBackupBackupPlanDetails awsBackupBackupPlan
Provides details about an Backup backup plan.
AwsBackupRecoveryPointDetails awsBackupRecoveryPoint
Provides details about an Backup backup, or recovery point.
AwsEc2LaunchTemplateDetails awsEc2LaunchTemplate
AwsSageMakerNotebookInstanceDetails awsSageMakerNotebookInstance
AwsWafv2WebAclDetails awsWafv2WebAcl
AwsWafv2RuleGroupDetails awsWafv2RuleGroup
AwsEc2RouteTableDetails awsEc2RouteTable
Provides details about a route table. A route table contains a set of rules, called routes, that determine where to direct network traffic from your subnet or gateway.
AwsAmazonMqBrokerDetails awsAmazonMqBroker
Provides details about AppSync message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
AwsAppSyncGraphQlApiDetails awsAppSyncGraphQlApi
Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.
AwsEventSchemasRegistryDetails awsEventSchemasRegistry
A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for schemas. They collect and organize schemas so that your schemas are in logical groups.
AwsGuardDutyDetectorDetails awsGuardDutyDetector
Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.
AwsStepFunctionStateMachineDetails awsStepFunctionStateMachine
Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-driven steps.
AwsAthenaWorkGroupDetails awsAthenaWorkGroup
Provides information about an Amazon Athena workgroup. A workgroup helps you separate users, teams, applications, or workloads. It also helps you set limits on data processing and track costs.
AwsEventsEventbusDetails awsEventsEventbus
Provides details about Amazon EventBridge event bus for an endpoint. An event bus is a router that receives events and delivers them to zero or more destinations, or targets.
AwsDmsEndpointDetails awsDmsEndpoint
Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data store type, and location information about your data store.
AwsEventsEndpointDetails awsEventsEndpoint
Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s availability by making it Regional-fault tolerant.
AwsDmsReplicationTaskDetails awsDmsReplicationTask
Provides details about an DMS replication task. A replication task moves a set of data from the source endpoint to the target endpoint.
AwsDmsReplicationInstanceDetails awsDmsReplicationInstance
Provides details about an DMS replication instance. DMS uses a replication instance to connect to your source data store, read the source data, and format the data for consumption by the target data store.
AwsRoute53HostedZoneDetails awsRoute53HostedZone
Provides details about an Amazon Route 53 hosted zone, including the four name servers assigned to the hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.
AwsMskClusterDetails awsMskCluster
Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.
String code
String carrierGatewayId
The ID of the carrier gateway.
String coreNetworkArn
The Amazon Resource Name (ARN) of the core network.
String destinationCidrBlock
The IPv4 CIDR block used for the destination match.
String destinationIpv6CidrBlock
The IPv6 CIDR block used for the destination match.
String destinationPrefixListId
The prefix of the destination Amazon Web Service.
String egressOnlyInternetGatewayId
The ID of the egress-only internet gateway.
String gatewayId
The ID of a gateway attached to your VPC.
String instanceId
The ID of a NAT instance in your VPC.
String instanceOwnerId
The ID of the Amazon Web Services account that owns the instance.
String localGatewayId
The ID of the local gateway.
String natGatewayId
The ID of a NAT gateway.
String networkInterfaceId
The ID of the network interface.
String origin
Describes how the route was created.
String state
The state of the route.
String transitGatewayId
The ID of a transit gateway.
String vpcPeeringConnectionId
The ID of a VPC peering connection.
RuleGroupVariables ruleVariables
Additional settings to use in the specified rules.
RuleGroupSource rulesSource
The rules and actions for the rule group.
For stateful rule groups, can contain RulesString, RulesSourceList, or
StatefulRules.
For stateless rule groups, contains StatelessRulesAndCustomActions.
RuleGroupSourceListDetails rulesSourceList
Stateful inspection criteria for a domain list rule group. A domain list rule group determines access by specific protocols to specific domains.
String rulesString
Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.
List<E> statefulRules
Suricata rule specifications.
RuleGroupSourceStatelessRulesAndCustomActionsDetails statelessRulesAndCustomActions
The stateless rules and custom actions used by a stateless rule group.
StatelessCustomActionDefinition actionDefinition
The definition of a custom action.
String actionName
A descriptive name of the custom action.
String generatedRulesType
Indicates whether to allow or deny access to the domains listed in Targets.
List<E> targetTypes
The protocols that you want to inspect. Specify LS_SNI for HTTPS. Specify HTTP_HOST for
HTTP. You can specify either or both.
List<E> targets
The domains that you want to inspect for in your traffic flows. You can provide full domain names, or use the '.'
prefix as a wildcard. For example, .example.com matches all domains that end with
example.com.
String action
Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
RuleGroupSourceStatefulRulesHeaderDetails header
The stateful inspection criteria for the rule.
List<E> ruleOptions
Additional options for the rule.
String destination
The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY.
String destinationPort
The destination port to inspect for. You can specify an individual port, such as 1994. You also can
specify a port range, such as 1990:1994. To match with any port, specify ANY.
String direction
The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional
traffic, both from the source to the destination and from the destination to the source. If set to
FORWARD, the inspection only matches traffic going from the source to the destination.
String protocol
The protocol to inspect for. To inspector for all protocols, use IP.
String source
The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify
ANY.
String sourcePort
The source port to inspect for. You can specify an individual port, such as 1994. You also can
specify a port range, such as 1990:1994. To match with any port, specify ANY.
List<E> actions
The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must
specify a standard action (aws:pass, aws:drop, or aws:forward_to_sfe). You
can then add custom actions.
RuleGroupSourceStatelessRuleMatchAttributes matchAttributes
The criteria for Network Firewall to use to inspect an individual packet in a stateless rule inspection.
List<E> destinationPorts
A list of port ranges to specify the destination ports to inspect for.
List<E> destinations
The destination IP addresses and address ranges to inspect for, in CIDR notation.
List<E> protocols
The protocols to inspect for.
List<E> sourcePorts
A list of port ranges to specify the source ports to inspect for.
List<E> sources
The source IP addresses and address ranges to inspect for, in CIDR notation.
List<E> tcpFlags
The TCP flags and masks to inspect for.
String addressDefinition
An IP address or a block of IP addresses.
String addressDefinition
An IP address or a block of IP addresses.
List<E> flags
Defines the flags from the Masks setting that must be set in order for the packet to match. Flags
that are listed must be set. Flags that are not listed must not be set.
List<E> masks
The set of flags to consider in the inspection. If not specified, then all flags are inspected.
Integer priority
Indicates the order in which to run this rule relative to all of the rules in the stateless rule group.
RuleGroupSourceStatelessRuleDefinition ruleDefinition
Provides the definition of the stateless rule.
RuleGroupVariablesIpSetsDetails ipSets
A list of IP addresses and address ranges, in CIDR notation.
RuleGroupVariablesPortSetsDetails portSets
A list of port ranges.
String securityControlId
The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number, such as APIGateway.3.
String securityControlArn
The Amazon Resource Name (ARN) for a security control across standards, such as
arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention
a specific standard.
String title
The title of a security control.
String description
The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.
String remediationUrl
A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
String severityRating
The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.
String securityControlStatus
The enablement status of a security control in a specific standard.
String securityControlId
The unique identifier of a security control across standards. Values for this field typically consist of an
Amazon Web Service name and a number (for example, APIGateway.3). This parameter differs from
SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN
references the security control ID (for example,
arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
String title
The title of a security control.
String description
The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.
String remediationUrl
A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
String severityRating
The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.
String currentRegionAvailability
Specifies whether a security control is available in the current Amazon Web Services Region.
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 fixedInVersion
The version of the software package in which the vulnerability has been resolved.
String remediation
Describes the actions a customer can take to resolve the vulnerability in the software package.
String sourceLayerHash
The source layer hash of the vulnerable package.
String sourceLayerArn
The Amazon Resource Name (ARN) of the source layer.
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.
StandardsManagedBy standardsManagedBy
Provides details about the management of a standard.
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 standardsArn
The Amazon Resource Name (ARN) of a security standard.
String securityControlId
The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number, such as APIGateway.3.
String securityControlArn
The ARN of a security control across standards, such as
arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention
a specific standard.
String associationStatus
Specifies whether a control is enabled or disabled in a specified standard.
List<E> relatedRequirements
The requirement that underlies a control in the compliance framework related to the standard.
Date updatedAt
The time at which the enablement status of the control in the specified standard was last updated.
String updatedReason
The reason for updating the enablement status of a control in a specified standard.
String standardsControlTitle
The title of a control. This field may reference a specific standard.
String standardsControlDescription
The description of a control. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter may reference a specific standard.
List<E> standardsControlArns
Provides the input parameter that Security Hub uses to call the UpdateStandardsControl API. This API can be used to enable or disable a control in a specified standard.
String standardsArn
The Amazon Resource Name (ARN) of a standard.
String securityControlId
A unique standard-agnostic identifier for a control. Values for this field typically consist of an Amazon Web Service and a number, such as APIGateway.5. This field doesn't reference a specific standard.
String securityControlArn
The ARN of a control, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1.
This parameter doesn't mention a specific standard.
String associationStatus
The enablement status of a control in a specific standard.
List<E> relatedRequirements
The requirement that underlies this control in the compliance framework related to the standard.
Date updatedAt
The last time that a control's enablement status in a specified standard was updated.
String updatedReason
The reason for updating the control's enablement status in a specified standard.
String standardsControlTitle
The title of a control.
String standardsControlDescription
The description of a control. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. The parameter may reference a specific standard.
String standardsArn
The Amazon Resource Name (ARN) of the standard in which you want to update the control's enablement status.
String securityControlId
The unique identifier for the security control whose enablement status you want to update.
String associationStatus
The desired enablement status of the control in the standard.
String updatedReason
The reason for updating the control's enablement status in the standard.
String company
An identifier for the company that manages a specific security standard. For existing standards, the value is
equal to Amazon Web Services.
String product
An identifier for the product that manages a specific security standard. For existing standards, the value is equal to the Amazon Web Services service that manages the standard.
String statusReasonCode
The reason code that represents the reason for the current status of a standard subscription.
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.
StandardsStatusReason standardsStatusReason
The reason for the current status.
StatelessCustomPublishMetricAction publishMetricAction
Information about metrics to publish to CloudWatch.
String value
The value to use for the custom metric dimension.
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 value, there's no
match.
String comparison
The condition to apply to a string value when filtering Security Hub findings.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use CONTAINS. For example, the filter
Title CONTAINS CloudFront matches findings that have a Title that includes the string
CloudFront.
To search for values that exactly match the filter value, use EQUALS. For example, the filter
AwsAccountId EQUALS 123456789012 only matches findings that have an account ID of
123456789012.
To search for values that start with the filter value, use PREFIX. For example, the filter
ResourceRegion PREFIX us matches findings that have a ResourceRegion that starts with
us. A ResourceRegion that starts with a different value, such as af,
ap, or ca, doesn't match.
CONTAINS, EQUALS, and PREFIX filters on the same field are joined by
OR. A finding matches if it matches any one of those filters. For example, the filters
Title CONTAINS CloudFront OR Title CONTAINS CloudWatch match a finding that includes either
CloudFront, CloudWatch, or both strings in the title.
To search for values that don’t have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use NOT_CONTAINS. For example, the filter
Title NOT_CONTAINS CloudFront matches findings that have a Title that excludes the
string CloudFront.
To search for values other than the filter value, use NOT_EQUALS. For example, the filter
AwsAccountId NOT_EQUALS 123456789012 only matches findings that have an account ID other than
123456789012.
To search for values that don't start with the filter value, use PREFIX_NOT_EQUALS. For example, the
filter ResourceRegion PREFIX_NOT_EQUALS us matches findings with a ResourceRegion that
starts with a value other than us.
NOT_CONTAINS, 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 example, the
filters Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch match a finding that
excludes both CloudFront and CloudWatch in the title.
You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field.
Similarly, you can't provide both an EQUALS filter and a NOT_EQUALS or
PREFIX_NOT_EQUALS filter on the same field. Combining filters in this way returns an error.
CONTAINS filters can only be used with other CONTAINS filters.
NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters.
You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS
filters for the same field. Security Hub first processes the PREFIX filters, and then the
NOT_EQUALS or PREFIX_NOT_EQUALS filters.
For example, for the following filters, 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
CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more
information, see Automation rules in the
Security Hub User Guide.
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, and date and time should be
separated by T. 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.
String securityControlId
The control (identified with SecurityControlId, SecurityControlArn, or a mix of both
parameters) for which a response couldn't be returned.
String errorCode
The error code for the unprocessed security control.
String errorReason
The reason why the security control was unprocessed.
StandardsControlAssociationId standardsControlAssociationId
An array with one or more objects that includes a security control (identified with
SecurityControlId, SecurityControlArn, or a mix of both parameters) and the Amazon
Resource Name (ARN) of a standard. This parameter shows the specific controls for which the enablement status
couldn't be retrieved in specified standards when calling BatchUpdateStandardsControlAssociations.
String errorCode
The error code for the unprocessed standard and control association.
String errorReason
The reason why the standard and control association was unprocessed.
StandardsControlAssociationUpdate standardsControlAssociationUpdate
An array of control and standard associations for which an update failed when calling BatchUpdateStandardsControlAssociations.
String errorCode
The error code for the unprocessed update of the control's enablement status in the specified standard.
String errorReason
The reason why a control's enablement status in the specified standard couldn't be updated.
String ruleArn
The Amazon Resource Name (ARN) for the rule.
String ruleStatus
Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub
starts applying the rule to findings and finding updates after the rule is created. To change the value of this
parameter after creating a rule, use
BatchUpdateAutomationRules .
Integer ruleOrder
An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
String description
A description of the rule.
String ruleName
The name of the rule.
Boolean isTerminal
Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
AutomationRulesFindingFilters criteria
A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.
List<E> actions
One or more actions to update finding fields if a finding matches the conditions specified in
Criteria.
String findingAggregatorArn
The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.
String regionLinkingMode
Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
The selected option also determines how to use the Regions provided in the Regions list.
The options are as follows:
ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled.
When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub
supports them and you opt into them.
ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where
Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose
this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them
and you opt into them.
SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the
Regions parameter. Security Hub does not automatically aggregate findings from new Regions.
List<E> regions
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated
list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of
Regions that do aggregate findings to the aggregation Region.
String findingAggregatorArn
The ARN of the finding aggregator.
String findingAggregationRegion
The aggregation Region.
String regionLinkingMode
Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
List<E> regions
The list of excluded Regions or included Regions.
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.
String autoEnableStandards
Whether to automatically enable Security Hub default standards for new member accounts in the organization.
By default, this parameter is equal to DEFAULT, and new member accounts are automatically enabled
with default Security Hub standards.
To opt out of enabling default standards for new member accounts, set this parameter equal to NONE.
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 controlFindingGenerator
Updates whether the calling account has consolidated control findings turned on. If the value for this field is
set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the
check applies to multiple enabled standards.
If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for
a control check when the check applies to multiple enabled standards.
For accounts that are part of an organization, this value can only be updated in the administrator account.
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 cidrBlock
The IPv4 CIDR block for the VPC.
String ipv6CidrBlock
The IPv6 CIDR block for the VPC.
Boolean allowDnsResolutionFromRemoteVpc
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
Boolean allowEgressFromLocalClassicLinkToRemoteVpc
Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
Boolean allowEgressFromLocalVpcToRemoteClassicLink
Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
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 fixAvailable
Specifies if all vulnerable packages in a finding have a value for FixedInVersion and
Remediation. This field is evaluated for each vulnerability Id based on the number of
vulnerable packages that have a value for both FixedInVersion and Remediation. Valid
values are as follows:
YES if all vulnerable packages have a value for both FixedInVersion and
Remediation
NO if no vulnerable packages have a value for FixedInVersion and
Remediation
PARTIAL otherwise
Double epssScore
The Exploit Prediction Scoring System (EPSS) score for a finding.
String exploitAvailable
Whether an exploit is available for a finding.
List<E> codeVulnerabilities
The vulnerabilities found in your Lambda function code. This field pertains to findings that Security Hub receives from Amazon Inspector.
List<E> cwes
The Common Weakness Enumeration (CWE) item associated with the detected code vulnerability.
CodeVulnerabilitiesFilePath filePath
Provides details about where a code vulnerability is located in your Lambda function.
String sourceArn
The Amazon Resource Name (ARN) of the Lambda layer in which the code vulnerability is located.
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, and date and time should be
separated by T. 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, and date and time should be
separated by T. 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 web ACL.
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 © 2023. All rights reserved.