Skip to content

Commit

Permalink
Update descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@lloesche
lloesche committed Nov 3, 2023
1 parent ce5ba2d commit 4643f9e
Show file tree
Hide file tree
Showing 20 changed files with 270 additions and 278 deletions.
5 changes: 3 additions & 2 deletions plugins/aws/resoto_plugin_aws/resource/athena.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,9 @@ class AwsAthenaWorkGroup(AwsResource):
kind: ClassVar[str] = "aws_athena_work_group"
kind_display: ClassVar[str] = "AWS Athena Work Group"
kind_description: ClassVar[str] = (
"An AWS Athena Work Group is a named set of query execution and data usage controls that"
" Athena users can share among workloads and teams."
"Amazon Athena Work Groups are a resource type for isolating query execution and history among different"
" users, teams, or applications within the same AWS account, with features for access control, cost"
" management, and integration with AWS CloudWatch for metrics monitoring."
)
api_spec: ClassVar[AwsApiSpec] = AwsApiSpec(service_name, "list-work-groups", "WorkGroups")
mapping: ClassVar[Dict[str, Bender]] = {
Expand Down
10 changes: 5 additions & 5 deletions plugins/aws/resoto_plugin_aws/resource/cloudformation.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,9 +214,9 @@ class AwsCloudFormationAutoDeployment:
kind: ClassVar[str] = "aws_cloudformation_auto_deployment"
kind_display: ClassVar[str] = "AWS CloudFormation Auto Deployment"
kind_description: ClassVar[str] = (
"AWS CloudFormation Auto Deployment is a service that automates the"
" deployment of CloudFormation templates in the AWS Cloud, making it easier to"
" provision and manage a stack of AWS resources."
"AWS CloudFormation Auto Deployment is a setting within AWS CloudFormation that enables the automatic"
" deployment and updating of stacks or resources, typically in response to direct changes to source"
" code or a deployment pipeline, streamlining the deployment process."
)
mapping: ClassVar[Dict[str, Bender]] = {
"enabled": S("Enabled"),
Expand Down Expand Up @@ -349,8 +349,8 @@ class AwsCloudFormationStackInstanceSummary(AwsResource):
kind: ClassVar[str] = "aws_cloud_formation_stack_instance_summary"
kind_display: ClassVar[str] = "AWS CloudFormation Stack Instance Summary"
kind_description: ClassVar[str] = (
"CloudFormation Stack Instance Summary provides a summary of instances in a"
" CloudFormation stack, including instance ID, status, and stack name."
"CloudFormation Stack Instance Summary provides a summary of the overall stacks in a CloudFormation"
" deployment. The information includes current status, name, and any associated resources or parameters."
)
mapping: ClassVar[Dict[str, Bender]] = {
"id": F(_stack_instance_id),
Expand Down
70 changes: 37 additions & 33 deletions plugins/aws/resoto_plugin_aws/resource/cloudfront.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -680,9 +680,10 @@ def delete_resource(self, client: AwsClient, graph: Graph) -> bool:
class AwsCloudFrontPublicKey(CloudFrontResource, AwsResource):
kind: ClassVar[str] = "aws_cloudfront_public_key"
kind_display: ClassVar[str] = "AWS CloudFront Public Key"
kind_description: ClassVar[
str
] = "AWS CloudFront Public Key is a public key used for encrypting content stored on AWS CloudFront."
kind_description: ClassVar[str] = (
"AWS CloudFront Public Key is a public key used in conjunction with a private key for managing the"
" identity of the content distributors and validating access to content served by AWS CloudFront."
)
api_spec: ClassVar[AwsApiSpec] = AwsApiSpec(service_name, "list-public-keys", "PublicKeyList.Items")
mapping: ClassVar[Dict[str, Bender]] = {
"id": S("Id"),
Expand Down Expand Up @@ -724,9 +725,8 @@ class AwsCloudFrontEndPoint:
kind: ClassVar[str] = "aws_cloudfront_end_point"
kind_display: ClassVar[str] = "AWS CloudFront End Point"
kind_description: ClassVar[str] = (
"CloudFront End Points provide a globally distributed content delivery"
" network (CDN) that delivers data, videos, applications, and APIs to viewers"
" with low latency and high transfer speeds."
"An AWS CloudFront End Point is the DNS domain name that CloudFront assigns when you create a distribution."
" You use this domain name in all URLs for your files."
)
mapping: ClassVar[Dict[str, Bender]] = {
"stream_type": S("StreamType"),
Expand Down Expand Up @@ -801,9 +801,9 @@ class AwsCloudFrontResponseHeadersPolicyXSSProtection:
kind: ClassVar[str] = "aws_cloudfront_response_headers_policy_xss_protection"
kind_display: ClassVar[str] = "AWS CloudFront Response Headers Policy XSS Protection"
kind_description: ClassVar[str] = (
"The AWS CloudFront Response Headers Policy XSS Protection allows users to"
" configure Cross-Site Scripting (XSS) protection in the response headers of"
" their CloudFront distributions."
"AWS CloudFront Response Headers Policy XSS Protection are settings within the policy that control the"
" `X-XSS-Protection` header, which can be used to enable a browser's built-in cross-site scripting (XSS)"
" filters to prevent and mitigate XSS attacks on web content served through CloudFront."
)
mapping: ClassVar[Dict[str, Bender]] = {
"override": S("Override"),
Expand All @@ -822,9 +822,10 @@ class AwsCloudFrontResponseHeadersPolicyFrameOptions:
kind: ClassVar[str] = "aws_cloudfront_response_headers_policy_frame_options"
kind_display: ClassVar[str] = "AWS CloudFront Response Headers Policy Frame Options"
kind_description: ClassVar[str] = (
"CloudFront Response Headers Policy Frame Options is a feature of Amazon"
" CloudFront that allows you to control the frame options in HTTP responses"
" sent by CloudFront distributions."
"AWS CloudFront Response Headers Policy Frame Options within a response headers policy dictate how browsers"
" should handle the framing of pages, typically used to configure the `X-Frame-Options` header for"
" clickjacking protection by specifying whether content can be displayed within frames and under"
" what conditions."
)
mapping: ClassVar[Dict[str, Bender]] = {"override": S("Override"), "frame_option": S("FrameOption")}
override: Optional[bool] = field(default=None)
Expand Down Expand Up @@ -1062,9 +1063,9 @@ class AwsCloudFrontOriginAccessControl(CloudFrontResource, AwsResource):
kind: ClassVar[str] = "aws_cloudfront_origin_access_control"
kind_display: ClassVar[str] = "AWS CloudFront Origin Access Control"
kind_description: ClassVar[str] = (
"CloudFront Origin Access Control is a feature in AWS CloudFront that allows"
" you to restrict access to your origin server by using an Amazon S3 bucket or"
" an HTTP server as the source for your website or application files."
"AWS CloudFront Origin Access Control is a security feature that allows you to control access"
" to your S3 bucket or custom origin, ensuring that your content can only be accessed via"
" CloudFront distributions and not directly from the origin itself."
)
api_spec: ClassVar[AwsApiSpec] = AwsApiSpec(
service_name, "list-origin-access-controls", "OriginAccessControlList.Items"
Expand Down Expand Up @@ -1098,9 +1099,9 @@ class AwsCloudFrontCachePolicyHeadersConfig:
kind: ClassVar[str] = "aws_cloudfront_cache_policy_headers_config"
kind_display: ClassVar[str] = "AWS CloudFront Cache Policy Headers Config"
kind_description: ClassVar[str] = (
"The AWS CloudFront Cache Policy Headers Config allows users to configure the"
" cache headers for content in the CloudFront CDN, determining how long"
" content is cached and how it is delivered to end users."
"AWS CloudFront Cache Policy Headers Config specifies which HTTP headers CloudFront includes in the cache key"
" and, consequently, which headers it uses to determine whether to serve a cached response or to forward a"
" request to the origin. This configuration influences cache hit ratios and content delivery performance."
)
mapping: ClassVar[Dict[str, Bender]] = {
"header_behavior": S("HeaderBehavior"),
Expand Down Expand Up @@ -1229,9 +1230,10 @@ class AwsCloudFrontQueryArgProfile:
kind: ClassVar[str] = "aws_cloudfront_query_arg_profile"
kind_display: ClassVar[str] = "AWS CloudFront Query Argument Profile"
kind_description: ClassVar[str] = (
"CloudFront Query Argument Profile in AWS is a configuration that allows you"
" to control how CloudFront caches and forwards query strings in the URLs of"
" your content."
"AWS CloudFront Query Argument Profile is part of CloudFront's Field-Level Encryption feature;"
" it specifies how CloudFront handles query arguments by applying field patterns that match and"
" encrypt query argument values when they are forwarded to the origin, enhancing the security"
" of sensitive data."
)
mapping: ClassVar[Dict[str, Bender]] = {"query_arg": S("QueryArg"), "profile_id": S("ProfileId")}
query_arg: Optional[str] = field(default=None)
Expand All @@ -1243,9 +1245,10 @@ class AwsCloudFrontQueryArgProfileConfig:
kind: ClassVar[str] = "aws_cloudfront_query_arg_profile_config"
kind_display: ClassVar[str] = "AWS CloudFront Query Arg Profile Config"
kind_description: ClassVar[str] = (
"CloudFront Query Arg Profile Config is a feature in AWS CloudFront that"
" allows you to configure personalized caching behavior for different query"
" strings on your website."
"CloudFront Query Arg Profile Config is a configuration within AWS CloudFront's Field-Level Encryption"
" setup that specifies the profiles to use for encrypting specific query arguments in viewer requests,"
" enhancing security by ensuring sensitive information is encrypted as it passes from CloudFront"
" to the origin."
)
mapping: ClassVar[Dict[str, Bender]] = {
"forward_when_query_arg_profile_is_unknown": S("ForwardWhenQueryArgProfileIsUnknown"),
Expand All @@ -1261,9 +1264,9 @@ class AwsCloudFrontContentTypeProfile:
kind: ClassVar[str] = "aws_cloudfront_content_type_profile"
kind_display: ClassVar[str] = "AWS CloudFront Content Type Profile"
kind_description: ClassVar[str] = (
"AWS CloudFront Content Type Profiles help you manage the behavior of"
" CloudFront by configuring how it handles content types for different file"
" extensions or MIME types."
"AWS CloudFront Content Type Profile is a configuration option within CloudFront that maps file extensions"
" to content types, which is used in Field-Level Encryption to apply encryption based on the content type"
" of the forwarded content in a request."
)
mapping: ClassVar[Dict[str, Bender]] = {
"format": S("Format"),
Expand All @@ -1280,9 +1283,10 @@ class AwsCloudFrontContentTypeProfileConfig:
kind: ClassVar[str] = "aws_cloudfront_content_type_profile_config"
kind_display: ClassVar[str] = "AWS CloudFront Content Type Profile Config"
kind_description: ClassVar[str] = (
"AWS CloudFront Content Type Profile Config is a configuration object that"
" allows you to specify how CloudFront should interpret and act upon the"
" Content-Type header of viewer requests for your content."
"AWS CloudFront Content Type Profile Config is a setting within AWS CloudFront's Field-Level Encryption"
" that defines a set of profiles mapping query argument or form field names to their respective content"
" type, which is used to determine how specified fields in viewer requests are encrypted before being"
" forwarded to the origin."
)
mapping: ClassVar[Dict[str, Bender]] = {
"forward_when_content_type_is_unknown": S("ForwardWhenContentTypeIsUnknown"),
Expand All @@ -1298,9 +1302,9 @@ class AwsCloudFrontFieldLevelEncryptionConfig(CloudFrontResource, AwsResource):
kind: ClassVar[str] = "aws_cloudfront_field_level_encryption_config"
kind_display: ClassVar[str] = "AWS CloudFront Field-Level Encryption Configuration"
kind_description: ClassVar[str] = (
"AWS CloudFront Field-Level Encryption Configuration is a feature that allows"
" you to encrypt selected fields in HTTP requests and responses before they"
" are sent and after they are received by CloudFront."
"AWS CloudFront Field-Level Encryption Configuration is a feature that helps you to protect sensitive data"
" by encrypting specific HTTP fields at CloudFront edge locations. It allows you to encrypt data within"
" each individual field of an HTTPS request or response."
)
api_spec: ClassVar[AwsApiSpec] = AwsApiSpec(
service_name, "list-field-level-encryption-configs", "FieldLevelEncryptionList.Items"
Expand Down
6 changes: 3 additions & 3 deletions plugins/aws/resoto_plugin_aws/resource/config.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ class AwsConfigRecorderStatus:
kind: ClassVar[str] = "aws_config_recorder_status"
kind_display: ClassVar[str] = "AWS Config Recorder Status"
kind_description: ClassVar[str] = (
"AWS Config Recorder Status indicates whether the AWS Config service is actively recording changes"
" to AWS resources and configurations in the account, along with details like the last start or"
" stop time, any errors, and the recording mode (all resources or selective resource types)."
"AWS Config Recorder Status helps you to understand and manage the configurations of your AWS resources."
" It provides an overview of whether your AWS Config Recorder is recording resource configuration and"
" compliance data correctly or facing issues."
)
mapping: ClassVar[Dict[str, Bender]] = {
"last_start_time": S("lastStartTime"),
Expand Down
21 changes: 11 additions & 10 deletions plugins/aws/resoto_plugin_aws/resource/dynamodb.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ class AwsDynamoDbLocalSecondaryIndexDescription:
kind: ClassVar[str] = "aws_dynamo_db_local_secondary_index_description"
kind_display: ClassVar[str] = "AWS DynamoDB Local Secondary Index Description"
kind_description: ClassVar[str] = (
"AWS DynamoDB Local Secondary Index Description provides details about a local secondary index for a"
" DynamoDB table, including index name, key schema, projection details (attributes included in the"
" index), and index size along with item count."
"The AWS DynamoDB Local Secondary Index Description provides details about a Local Secondary Index (LSI)"
" associated with a DynamoDB table. This includes information such as the index name, the key schema, the"
" projection, and throughput information if provisioned throughput is specified."
)
mapping: ClassVar[Dict[str, Bender]] = {
"index_name": S("IndexName"),
Expand Down Expand Up @@ -204,9 +204,12 @@ class AwsDynamoDbReplicaGlobalSecondaryIndexDescription:
kind: ClassVar[str] = "aws_dynamo_db_replica_global_secondary_index_description"
kind_display: ClassVar[str] = "AWS DynamoDB Replica Global Secondary Index Description"
kind_description: ClassVar[str] = (
"AWS DynamoDB Replica Global Secondary Index Description contains information about the global secondary"
" indexes on the replica table in a DynamoDB global table setup, including details like the index name,"
" status, provisioned read and write capacity, and index size."
"The AWS DynamoDB Replica Global Secondary Index Description details the properties of a"
" Global Secondary Index (GSI) on a replica table in a DynamoDB global table configuration."
" It includes the index name, key schema, attribute projections, provisioned read and write"
" capacity (if not using on-demand capacity), index status, and other metrics such as"
" index size and item count. GSIs on replicas enable fast, efficient query performance"
" across multiple geographically dispersed tables."
)
mapping: ClassVar[Dict[str, Bender]] = {
"index_name": S("IndexName"),
Expand All @@ -221,10 +224,8 @@ class AwsDynamoDbTableClassSummary:
kind: ClassVar[str] = "aws_dynamo_db_table_class_summary"
kind_display: ClassVar[str] = "AWS DynamoDB Table Class Summary"
kind_description: ClassVar[str] = (
"DynamoDB Table Class Summary provides information about the classes of"
" tables in Amazon DynamoDB, a fully managed NoSQL database service provided"
" by AWS. It enables users to store and retrieve any amount of data with high"
" availability and durability."
"The AWS DynamoDB Table Class Summary provides an overview of the table class for"
" a DynamoDB table, which reflects the cost and performance characteristics of the table."
)
mapping: ClassVar[Dict[str, Bender]] = {
"table_class": S("TableClass"),
Expand Down
Loading

0 comments on commit 4643f9e

Please sign in to comment.