Class ResourceCoverageSummary
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ResourceCoverageSummary.Builder,ResourceCoverageSummary>
Describes how an AWS Network Security Manager entity covers a protected resource.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final CoverageStatusSpecifies whether the entity contributes to the effective configuration of the resource for its firewall type.final StringSpecifies whether the entity contributes to the effective configuration of the resource for its firewall type.The Amazon Resource Names (ARNs) of the deployments through which the entity covers the resource.final StringThe Amazon Resource Name (ARN) of the entity that covers the resource.final ServiceResourceTypeThe type of the entity that covers the resource, such asPolicy.final StringThe type of the entity that covers the resource, such asPolicy.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final PolicyFirewallTypeThe firewall type of the policy that covers the resource.final StringThe firewall type of the policy that covers the resource.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the DeploymentArns property.final inthashCode()final StringThe Amazon Resource Name (ARN) of the protected resource.final StringThe AWS account ID that owns the protected resource.final ScopeResourceTypeThe type of the protected resource, in AWS CloudFormation format.final StringThe type of the protected resource, in AWS CloudFormation format.static Class<? extends ResourceCoverageSummary.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final InstantThe time when AWS Network Security Manager last evaluated the coverage.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
resourceArn
The Amazon Resource Name (ARN) of the protected resource.
- Returns:
- The Amazon Resource Name (ARN) of the protected resource.
-
entityType
The type of the entity that covers the resource, such as
Policy.If the service returns an enum value that is not available in the current SDK version,
entityTypewill returnServiceResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromentityTypeAsString().- Returns:
- The type of the entity that covers the resource, such as
Policy. - See Also:
-
entityTypeAsString
The type of the entity that covers the resource, such as
Policy.If the service returns an enum value that is not available in the current SDK version,
entityTypewill returnServiceResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromentityTypeAsString().- Returns:
- The type of the entity that covers the resource, such as
Policy. - See Also:
-
entityArn
The Amazon Resource Name (ARN) of the entity that covers the resource.
- Returns:
- The Amazon Resource Name (ARN) of the entity that covers the resource.
-
resourceOwnerAccountId
The AWS account ID that owns the protected resource. This can differ from the account that owns the entity.
- Returns:
- The AWS account ID that owns the protected resource. This can differ from the account that owns the entity.
-
resourceType
The type of the protected resource, in AWS CloudFormation format.
If the service returns an enum value that is not available in the current SDK version,
resourceTypewill returnScopeResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- The type of the protected resource, in AWS CloudFormation format.
- See Also:
-
resourceTypeAsString
The type of the protected resource, in AWS CloudFormation format.
If the service returns an enum value that is not available in the current SDK version,
resourceTypewill returnScopeResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- The type of the protected resource, in AWS CloudFormation format.
- See Also:
-
firewallType
The firewall type of the policy that covers the resource. This is present when
entityTypeisPolicy.If the service returns an enum value that is not available in the current SDK version,
firewallTypewill returnPolicyFirewallType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfirewallTypeAsString().- Returns:
- The firewall type of the policy that covers the resource. This is present when
entityTypeisPolicy. - See Also:
-
firewallTypeAsString
The firewall type of the policy that covers the resource. This is present when
entityTypeisPolicy.If the service returns an enum value that is not available in the current SDK version,
firewallTypewill returnPolicyFirewallType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfirewallTypeAsString().- Returns:
- The firewall type of the policy that covers the resource. This is present when
entityTypeisPolicy. - See Also:
-
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 isIN_EFFECTand the others areSUPERSEDED.If the service returns an enum value that is not available in the current SDK version,
coverageStatuswill returnCoverageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcoverageStatusAsString().- Returns:
- 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 isIN_EFFECTand the others areSUPERSEDED. - See Also:
-
coverageStatusAsString
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 isIN_EFFECTand the others areSUPERSEDED.If the service returns an enum value that is not available in the current SDK version,
coverageStatuswill returnCoverageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcoverageStatusAsString().- Returns:
- 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 isIN_EFFECTand the others areSUPERSEDED. - See Also:
-
hasDeploymentArns
public final boolean hasDeploymentArns()For responses, this returns true if the service returned a value for the DeploymentArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
deploymentArns
The Amazon Resource Names (ARNs) of the deployments through which the entity covers the resource.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDeploymentArns()method.- Returns:
- The Amazon Resource Names (ARNs) of the deployments through which the entity covers the resource.
-
updatedAt
The time when AWS Network Security Manager last evaluated the coverage.
- Returns:
- The time when AWS Network Security Manager last evaluated the coverage.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ResourceCoverageSummary.Builder,ResourceCoverageSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-