View a markdown version of this page

ResourceCoverageSummary - AWS Network Security Manager

ResourceCoverageSummary

Describes how an AWS Network Security Manager entity covers a protected resource.

Contents

coverageStatus

Specifies whether the entity contributes to the effective configuration of the resource for its firewall type. For firewall types that combine policies, such as AWS WAF and AWS Shield Advanced, every policy that covers the resource is IN_EFFECT. For firewall types that apply a single policy, only the highest-priority policy is IN_EFFECT and the others are SUPERSEDED.

Type: String

Valid Values: IN_EFFECT | SUPERSEDED

Required: No

deploymentArns

The Amazon Resource Names (ARNs) of the deployments through which the entity covers the resource.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 20. Maximum length of 1010.

Pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

Required: No

entityArn

The Amazon Resource Name (ARN) of the entity that covers the resource.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1010.

Pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

Required: No

entityType

The type of the entity that covers the resource, such as Policy.

Type: String

Valid Values: Rule | Template | Policy | Deployment | Scope

Required: No

firewallType

The firewall type of the policy that covers the resource. This is present when entityType is Policy.

Type: String

Valid Values: WAF | SHIELD_ADVANCED | IGW_FIREWALL

Required: No

resourceArn

The Amazon Resource Name (ARN) of the protected resource.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1010.

Pattern: arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:(.+)

Required: No

resourceOwnerAccountId

The AWS account ID that owns the protected resource. This can differ from the account that owns the entity.

Type: String

Length Constraints: Fixed length of 12.

Pattern: (?:[0-9]{12})

Required: No

resourceType

The type of the protected resource, in AWS CloudFormation format.

Type: String

Valid Values: AWS::ApiGateway::Stage | AWS::CloudFront::Distribution | AWS::EC2::EIP | AWS::ElasticLoadBalancingV2::LoadBalancer::application | AWS::ElasticLoadBalancing::LoadBalancer | AWS::EC2::VPC | AWS::EC2::Subnet

Required: No

updatedAt

The time when AWS Network Security Manager last evaluated the coverage.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: