You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecurityHub::Types::Resource

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Resource as input to an Aws::Client method, you can use a vanilla Hash:

{
  type: "NonEmptyString", # required
  id: "NonEmptyString", # required
  partition: "aws", # accepts aws, aws-cn, aws-us-gov
  region: "NonEmptyString",
  tags: {
    "NonEmptyString" => "NonEmptyString",
  },
  details: {
    aws_cloud_front_distribution: {
      domain_name: "NonEmptyString",
      etag: "NonEmptyString",
      last_modified_time: "NonEmptyString",
      logging: {
        bucket: "NonEmptyString",
        enabled: false,
        include_cookies: false,
        prefix: "NonEmptyString",
      },
      origins: {
        items: [
          {
            domain_name: "NonEmptyString",
            id: "NonEmptyString",
            origin_path: "NonEmptyString",
          },
        ],
      },
      status: "NonEmptyString",
      web_acl_id: "NonEmptyString",
    },
    aws_ec2_instance: {
      type: "NonEmptyString",
      image_id: "NonEmptyString",
      ip_v4_addresses: ["NonEmptyString"],
      ip_v6_addresses: ["NonEmptyString"],
      key_name: "NonEmptyString",
      iam_instance_profile_arn: "NonEmptyString",
      vpc_id: "NonEmptyString",
      subnet_id: "NonEmptyString",
      launched_at: "NonEmptyString",
    },
    aws_elbv_2_load_balancer: {
      availability_zones: [
        {
          zone_name: "NonEmptyString",
          subnet_id: "NonEmptyString",
        },
      ],
      canonical_hosted_zone_id: "NonEmptyString",
      created_time: "NonEmptyString",
      dns_name: "NonEmptyString",
      ip_address_type: "NonEmptyString",
      scheme: "NonEmptyString",
      security_groups: ["NonEmptyString"],
      state: {
        code: "NonEmptyString",
        reason: "NonEmptyString",
      },
      type: "NonEmptyString",
      vpc_id: "NonEmptyString",
    },
    aws_s3_bucket: {
      owner_id: "NonEmptyString",
      owner_name: "NonEmptyString",
    },
    aws_iam_access_key: {
      user_name: "NonEmptyString",
      status: "Active", # accepts Active, Inactive
      created_at: "NonEmptyString",
      principal_id: "NonEmptyString",
      principal_type: "NonEmptyString",
      principal_name: "NonEmptyString",
    },
    aws_iam_role: {
      assume_role_policy_document: "AwsIamRoleAssumeRolePolicyDocument",
      create_date: "NonEmptyString",
      role_id: "NonEmptyString",
      role_name: "NonEmptyString",
      max_session_duration: 1,
      path: "NonEmptyString",
    },
    aws_kms_key: {
      aws_account_id: "NonEmptyString",
      creation_date: 1.0,
      key_id: "NonEmptyString",
      key_manager: "NonEmptyString",
      key_state: "NonEmptyString",
      origin: "NonEmptyString",
    },
    aws_lambda_function: {
      code: {
        s3_bucket: "NonEmptyString",
        s3_key: "NonEmptyString",
        s3_object_version: "NonEmptyString",
        zip_file: "NonEmptyString",
      },
      code_sha_256: "NonEmptyString",
      dead_letter_config: {
        target_arn: "NonEmptyString",
      },
      environment: {
        variables: {
          "NonEmptyString" => "NonEmptyString",
        },
        error: {
          error_code: "NonEmptyString",
          message: "NonEmptyString",
        },
      },
      function_name: "NonEmptyString",
      handler: "NonEmptyString",
      kms_key_arn: "NonEmptyString",
      last_modified: "NonEmptyString",
      layers: [
        {
          arn: "NonEmptyString",
          code_size: 1,
        },
      ],
      master_arn: "NonEmptyString",
      memory_size: 1,
      revision_id: "NonEmptyString",
      role: "NonEmptyString",
      runtime: "NonEmptyString",
      timeout: 1,
      tracing_config: {
        mode: "NonEmptyString",
      },
      vpc_config: {
        security_group_ids: ["NonEmptyString"],
        subnet_ids: ["NonEmptyString"],
        vpc_id: "NonEmptyString",
      },
      version: "NonEmptyString",
    },
    aws_sns_topic: {
      kms_master_key_id: "NonEmptyString",
      subscription: [
        {
          endpoint: "NonEmptyString",
          protocol: "NonEmptyString",
        },
      ],
      topic_name: "NonEmptyString",
      owner: "NonEmptyString",
    },
    aws_sqs_queue: {
      kms_data_key_reuse_period_seconds: 1,
      kms_master_key_id: "NonEmptyString",
      queue_name: "NonEmptyString",
      dead_letter_target_arn: "NonEmptyString",
    },
    container: {
      name: "NonEmptyString",
      image_id: "NonEmptyString",
      image_name: "NonEmptyString",
      launched_at: "NonEmptyString",
    },
    other: {
      "NonEmptyString" => "NonEmptyString",
    },
  },
}

A resource related to a finding.

Instance Attribute Summary collapse

Instance Attribute Details

#detailsTypes::ResourceDetails

Additional details about the resource related to a finding.

Returns:

#idString

The canonical identifier for the given resource type.

Returns:

  • (String)

    The canonical identifier for the given resource type.

#partitionString

The canonical AWS partition name that the Region is assigned to.

Possible values:

  • aws
  • aws-cn
  • aws-us-gov

Returns:

  • (String)

    The canonical AWS partition name that the Region is assigned to.

#regionString

The canonical AWS external Region name where this resource is located.

Returns:

  • (String)

    The canonical AWS external Region name where this resource is located.

#tagsHash<String,String>

A list of AWS tags associated with a resource at the time the finding was processed.

Returns:

  • (Hash<String,String>)

    A list of AWS tags associated with a resource at the time the finding was processed.

#typeString

The type of the resource that details are provided for.

Returns:

  • (String)

    The type of the resource that details are provided for.