models.aws_credentials module

class models.aws_credentials.AwsCredentials(access_key=None, amazon_resource_name=None, auth_method=None, aws_type=None, iam_role_arn=None, secret_access_key=None, subscription_type=None)

Bases: object

Implementation of the ‘AwsCredentials’ model.

Specifies the credentials to authenticate with AWS Cloud Platform.

Attributes:

access_key (string): Specifies Access key of the AWS account. amazon_resource_name (string): Specifies Amazon Resource Name (owner

ID) of the IAM user, act as an unique identifier of as AWS entity.

auth_method (AuthMethodEnum): Specifies the iauth method used for the

request. See the Cohesity online help for the value to specify for this field based on the current S3-compatible Vault (External Target) type. Specifies the authentication method to be used for API calls. ‘kUseIAMUser’ indicates a user based authentication. ‘kUseIAMRole’ indicates a role based authentication, used only for AWS CE.

aws_type (AwsTypeEnum): Specifies the entity type such as ‘kIAMUser’

if the environment is kAWS. Specifies the type of an AWS source entity. ‘kIAMUser’ indicates a unique user within an AWS account. ‘kRegion’ indicates a geographical region in the global infrastructure. ‘kAvailabilityZone’ indicates an availability zone within a region. ‘kEC2Instance’ indicates a Virtual Machine running in AWS environment. ‘kVPC’ indicates a virtual private cloud (VPC) network within AWS. ‘kSubnet’ indicates a subnet inside the VPC. ‘kNetworkSecurityGroup’ represents a network security group. ‘kInstanceType’ represents various machine types. ‘kKeyPair’ represents a pair of public and private key used to login into a Virtual Machine. ‘kTag’ represents a tag attached to EC2 instance. ‘kRDSOptionGroup’ represents a RDS option group for configuring database features. ‘kRDSParameterGroup’ represents a RDS parameter group. ‘kRDSInstance’ represents a RDS DB instance. ‘kRDSSubnet’ represents a RDS subnet. ‘kRDSTag’ represents a tag attached to RDS instance. ‘kAuroraCluster’ represents an Aurora cluster.

iam_role_arn (string): Specifies the iam role arn Amazon service

account. See the Cohesity online help for the value to specify for this field based on the current S3-compatible Vault (External Target) type.

secret_access_key (string): Specifies Secret Access key of the AWS

account.

subscription_type (SubscriptionTypeEnum): Specifies the subscription

type of AWS such as ‘kAWSCommercial’ or ‘kAWSGovCloud’. Specifies the subscription type of an AWS source entity. ‘kAWSCommercial’ indicates a standard AWS subscription. ‘kAWSGovCloud’ indicates a govt AWS subscription.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.