Google BigQuery Connection V1 Client - Class AwsCrossAccountRole (2.0.0-RC1)

Reference documentation and code samples for the Google BigQuery Connection V1 Client class AwsCrossAccountRole.

Authentication method for Amazon Web Services (AWS) that uses Google owned AWS IAM user's access key to assume into customer's AWS IAM Role.

Generated from protobuf message google.cloud.bigquery.connection.v1.AwsCrossAccountRole

Namespace

Google \ Cloud \ BigQuery \ Connection \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ iam_role_id string

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

↳ iam_user_id string

Output only. Google-owned AWS IAM User for a Connection.

↳ external_id string

Output only. A Google-generated id for representing Connection’s identity in AWS. External Id is also used for preventing the Confused Deputy Problem. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

getIamRoleId

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

Returns
Type Description
string

setIamRoleId

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

Parameter
Name Description
var string
Returns
Type Description
$this

getIamUserId

Output only. Google-owned AWS IAM User for a Connection.

Returns
Type Description
string

setIamUserId

Output only. Google-owned AWS IAM User for a Connection.

Parameter
Name Description
var string
Returns
Type Description
$this

getExternalId

Output only. A Google-generated id for representing Connection’s identity in AWS. External Id is also used for preventing the Confused Deputy Problem. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

Returns
Type Description
string

setExternalId

Output only. A Google-generated id for representing Connection’s identity in AWS. External Id is also used for preventing the Confused Deputy Problem. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

Parameter
Name Description
var string
Returns
Type Description
$this