models.aws_protection_source module

class models.aws_protection_source.AwsProtectionSource(access_key=None, amazon_resource_name=None, auth_method=None, aws_fleet_params=None, aws_type=None, cluster_network_info=None, db_engine_id=None, host_type=None, iam_role_arn=None, ip_addresses=None, name=None, owner_id=None, physical_source_id=None, region_id=None, resource_id=None, restore_task_id=None, secret_access_key=None, subscription_type=None, tag_attributes=None, mtype=None, user_account_id=None, user_resource_name=None)

Bases: object

Implementation of the ‘AwsProtectionSource’ model.

Specifies a Protection Source in AWS environment.

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_fleet_params (AwsFleetParams): Specifies information related to

AWS fleets launched for various purposes. This will only be set for kIAMUser entity.

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.

cluster_network_info (FleetNetworkParams): Specifies information

related to cluster. This is only valid for CE clusters. This is only populated for kIAMUser entity.

db_engine_id (string): Specifies DB engine version info of the entity.

This is populated only for RDSInstance, RDSOptionGroup and RDSParameterGroup entity types.

host_type (HostTypeEnum): Specifies the OS type of the Protection

Source of type ‘kVirtualMachine’ such as ‘kWindows’ or ‘kLinux’. overrideDescription: true ‘kLinux’ indicates the Linux operating system. ‘kWindows’ indicates the Microsoft Windows operating system. ‘kAix’ indicates the IBM AIX operating system. ‘kSolaris’ indicates the Oracle Solaris operating system. ‘kSapHana’ indicates the Sap Hana database system developed by SAP SE. ‘kOther’ indicates the other types of operating system.

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.

ip_addresses (string): Specifies the IP address of the entity of type

‘kVirtualMachine’.

name (string): Specifies the name of the Object set by the Cloud

Provider. If the provider did not set a name for the object, this field is not set.

owner_id (string): Specifies the owner id of the resource in AWS

environment. With type, name and ownerId gives a globally unique identity to the AWS entity.

physical_source_id (long|int): Specifies the Protection Source id of

the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.

region_id (string): Specifies the region Id of the entity if the

entity is an EC2 instance.

resource_id (string): Specifies the unique Id of the resource given by

the cloud provider.

restore_task_id (long|int): Specifies the id of the “convert and

deploy” restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using “convert and deploy” mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity’s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the “convert and deploy” restore task. Restore entity associated with the above matched cloud entity has ‘failed_over’ flag set to true in its cloud extension.

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.

tag_attributes (list of TagAttribute): Specifies the list of AWS tag

attributes.

mtype (TypeAwsProtectionSourceEnum): Specifies the type of an AWS

Protection Source Object such as ‘kStorageContainer’, ‘kVirtualMachine’, ‘kVirtualNetwork’, etc. 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.

user_account_id (string): Specifies the account id derived from the

ARN of the user.

user_resource_name (string): Specifies the Amazon Resource Name (ARN)

of the user.

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.