Module: Aws::AccessAnalyzer::Types

Defined in:
gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb

Defined Under Namespace

Classes: AccessDeniedException, AccessPreview, AccessPreviewFinding, AccessPreviewStatusReason, AccessPreviewSummary, AclGrantee, AnalyzedResource, AnalyzedResourceSummary, AnalyzerSummary, ApplyArchiveRuleRequest, ArchiveRuleSummary, CancelPolicyGenerationRequest, CancelPolicyGenerationResponse, CloudTrailDetails, CloudTrailProperties, Configuration, ConflictException, CreateAccessPreviewRequest, CreateAccessPreviewResponse, CreateAnalyzerRequest, CreateAnalyzerResponse, CreateArchiveRuleRequest, Criterion, DeleteAnalyzerRequest, DeleteArchiveRuleRequest, EbsSnapshotConfiguration, EcrRepositoryConfiguration, EfsFileSystemConfiguration, Finding, FindingSource, FindingSourceDetail, FindingSummary, GeneratedPolicy, GeneratedPolicyProperties, GeneratedPolicyResult, GetAccessPreviewRequest, GetAccessPreviewResponse, GetAnalyzedResourceRequest, GetAnalyzedResourceResponse, GetAnalyzerRequest, GetAnalyzerResponse, GetArchiveRuleRequest, GetArchiveRuleResponse, GetFindingRequest, GetFindingResponse, GetGeneratedPolicyRequest, GetGeneratedPolicyResponse, IamRoleConfiguration, InlineArchiveRule, InternalServerException, JobDetails, JobError, KmsGrantConfiguration, KmsGrantConstraints, KmsKeyConfiguration, ListAccessPreviewFindingsRequest, ListAccessPreviewFindingsResponse, ListAccessPreviewsRequest, ListAccessPreviewsResponse, ListAnalyzedResourcesRequest, ListAnalyzedResourcesResponse, ListAnalyzersRequest, ListAnalyzersResponse, ListArchiveRulesRequest, ListArchiveRulesResponse, ListFindingsRequest, ListFindingsResponse, ListPolicyGenerationsRequest, ListPolicyGenerationsResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, Location, NetworkOriginConfiguration, PathElement, PolicyGeneration, PolicyGenerationDetails, Position, RdsDbClusterSnapshotAttributeValue, RdsDbClusterSnapshotConfiguration, RdsDbSnapshotAttributeValue, RdsDbSnapshotConfiguration, ResourceNotFoundException, S3AccessPointConfiguration, S3BucketAclGrantConfiguration, S3BucketConfiguration, S3PublicAccessBlockConfiguration, SecretsManagerSecretConfiguration, ServiceQuotaExceededException, SnsTopicConfiguration, SortCriteria, Span, SqsQueueConfiguration, StartPolicyGenerationRequest, StartPolicyGenerationResponse, StartResourceScanRequest, StatusReason, Substring, TagResourceRequest, TagResourceResponse, ThrottlingException, Trail, TrailProperties, UntagResourceRequest, UntagResourceResponse, UpdateArchiveRuleRequest, UpdateFindingsRequest, ValidatePolicyFinding, ValidatePolicyRequest, ValidatePolicyResponse, ValidationException, ValidationExceptionField, VpcConfiguration

Instance Attribute Summary collapse

Instance Attribute Details

#account_idsArray<String>

The Amazon Web Services account IDs that have access to the manual Amazon RDS DB snapshot. If the value all is specified, then the Amazon RDS DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.

  • If the configuration is for an existing Amazon RDS DB snapshot and you do not specify the accountIds in RdsDbSnapshotAttributeValue, then the access preview uses the existing shared accountIds for the snapshot.

  • If the access preview is for a new resource and you do not specify the specify the accountIds in RdsDbSnapshotAttributeValue, then the access preview considers the snapshot without any attributes.

  • To propose deletion of an existing shared accountIds, you can specify an empty list for accountIds in the RdsDbSnapshotAttributeValue.

Returns:

  • (Array<String>)


2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 2432

class RdsDbClusterSnapshotAttributeValue < Struct.new(
  :account_ids,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AccountIds < RdsDbClusterSnapshotAttributeValue; end
  class Unknown < RdsDbClusterSnapshotAttributeValue; end
end

#ebs_snapshotTypes::EbsSnapshotConfiguration

The access control configuration is for an Amazon EBS volume snapshot.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#ecr_repositoryTypes::EcrRepositoryConfiguration

The access control configuration is for an Amazon ECR repository.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#efs_file_systemTypes::EfsFileSystemConfiguration

The access control configuration is for an Amazon EFS file system.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#iam_roleTypes::IamRoleConfiguration

The access control configuration is for an IAM role.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#idString

The value specified is the canonical user ID of an Amazon Web Services account.

Returns:

  • (String)


277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 277

class AclGrantee < Struct.new(
  :id,
  :uri,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Id < AclGrantee; end
  class Uri < AclGrantee; end
  class Unknown < AclGrantee; end
end

#indexInteger

Refers to an index in a JSON array.

Returns:

  • (Integer)


2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 2307

class PathElement < Struct.new(
  :index,
  :key,
  :substring,
  :value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Index < PathElement; end
  class Key < PathElement; end
  class Substring < PathElement; end
  class Value < PathElement; end
  class Unknown < PathElement; end
end

#internet_configurationTypes::InternetConfiguration

The configuration for the Amazon S3 access point or multi-region access point with an Internet origin.

Returns:

  • (Types::InternetConfiguration)


2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 2271

class NetworkOriginConfiguration < Struct.new(
  :vpc_configuration,
  :internet_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class VpcConfiguration < NetworkOriginConfiguration; end
  class InternetConfiguration < NetworkOriginConfiguration; end
  class Unknown < NetworkOriginConfiguration; end
end

#keyString

Refers to a key in a JSON object.

Returns:

  • (String)


2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 2307

class PathElement < Struct.new(
  :index,
  :key,
  :substring,
  :value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Index < PathElement; end
  class Key < PathElement; end
  class Substring < PathElement; end
  class Value < PathElement; end
  class Unknown < PathElement; end
end

#kms_keyTypes::KmsKeyConfiguration

The access control configuration is for a KMS key.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#rds_db_cluster_snapshotTypes::RdsDbClusterSnapshotConfiguration

The access control configuration is for an Amazon RDS DB cluster snapshot.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#rds_db_snapshotTypes::RdsDbSnapshotConfiguration

The access control configuration is for an Amazon RDS DB snapshot.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#s3_bucketTypes::S3BucketConfiguration

The access control configuration is for an Amazon S3 Bucket.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#secrets_manager_secretTypes::SecretsManagerSecretConfiguration

The access control configuration is for a Secrets Manager secret.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#sns_topicTypes::SnsTopicConfiguration

The access control configuration is for an Amazon SNS topic



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#sqs_queueTypes::SqsQueueConfiguration

The access control configuration is for an Amazon SQS queue.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 644

class Configuration < Struct.new(
  :ebs_snapshot,
  :ecr_repository,
  :iam_role,
  :efs_file_system,
  :kms_key,
  :rds_db_cluster_snapshot,
  :rds_db_snapshot,
  :secrets_manager_secret,
  :s3_bucket,
  :sns_topic,
  :sqs_queue,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class EbsSnapshot < Configuration; end
  class EcrRepository < Configuration; end
  class IamRole < Configuration; end
  class EfsFileSystem < Configuration; end
  class KmsKey < Configuration; end
  class RdsDbClusterSnapshot < Configuration; end
  class RdsDbSnapshot < Configuration; end
  class SecretsManagerSecret < Configuration; end
  class S3Bucket < Configuration; end
  class SnsTopic < Configuration; end
  class SqsQueue < Configuration; end
  class Unknown < Configuration; end
end

#substringTypes::Substring

Refers to a substring of a literal string in a JSON object.

Returns:



2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 2307

class PathElement < Struct.new(
  :index,
  :key,
  :substring,
  :value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Index < PathElement; end
  class Key < PathElement; end
  class Substring < PathElement; end
  class Value < PathElement; end
  class Unknown < PathElement; end
end

#uriString

Used for granting permissions to a predefined group.

Returns:

  • (String)


277
278
279
280
281
282
283
284
285
286
287
288
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 277

class AclGrantee < Struct.new(
  :id,
  :uri,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Id < AclGrantee; end
  class Uri < AclGrantee; end
  class Unknown < AclGrantee; end
end

#valueString

Refers to the value associated with a given key in a JSON object.

Returns:

  • (String)


2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 2307

class PathElement < Struct.new(
  :index,
  :key,
  :substring,
  :value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Index < PathElement; end
  class Key < PathElement; end
  class Substring < PathElement; end
  class Value < PathElement; end
  class Unknown < PathElement; end
end

#vpc_configurationTypes::VpcConfiguration

The proposed virtual private cloud (VPC) configuration for the Amazon S3 access point. VPC configuration does not apply to multi-region access points. For more information, see VpcConfiguration.



2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
# File 'gems/aws-sdk-accessanalyzer/lib/aws-sdk-accessanalyzer/types.rb', line 2271

class NetworkOriginConfiguration < Struct.new(
  :vpc_configuration,
  :internet_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class VpcConfiguration < NetworkOriginConfiguration; end
  class InternetConfiguration < NetworkOriginConfiguration; end
  class Unknown < NetworkOriginConfiguration; end
end