harness.platform.AwsConnector
Resource for creating an AWS connector.
Create AwsConnector Resource
new AwsConnector(name: string, args: AwsConnectorArgs, opts?: CustomResourceOptions);
@overload
def AwsConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
cross_account_access: Optional[AwsConnectorCrossAccountAccessArgs] = None,
description: Optional[str] = None,
identifier: Optional[str] = None,
inherit_from_delegate: Optional[AwsConnectorInheritFromDelegateArgs] = None,
irsa: Optional[AwsConnectorIrsaArgs] = None,
manual: Optional[AwsConnectorManualArgs] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None)
@overload
def AwsConnector(resource_name: str,
args: AwsConnectorArgs,
opts: Optional[ResourceOptions] = None)
func NewAwsConnector(ctx *Context, name string, args AwsConnectorArgs, opts ...ResourceOption) (*AwsConnector, error)
public AwsConnector(string name, AwsConnectorArgs args, CustomResourceOptions? opts = null)
public AwsConnector(String name, AwsConnectorArgs args)
public AwsConnector(String name, AwsConnectorArgs args, CustomResourceOptions options)
type: harness:platform:AwsConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AwsConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AwsConnectorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AwsConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AwsConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AwsConnectorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AwsConnector Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The AwsConnector resource accepts the following input properties:
- Identifier string
Unique identifier of the resource.
- Cross
Account Lbrlabs.Access Pulumi Package. Harness. Platform. Inputs. Aws Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- Description string
Description of the resource.
- Inherit
From Lbrlabs.Delegate Pulumi Package. Harness. Platform. Inputs. Aws Connector Inherit From Delegate Args Inherit credentials from the delegate.
- Irsa
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Aws Connector Irsa Args Use IAM role for service accounts.
- Manual
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Aws Connector Manual Args Use IAM role for service accounts.
- Name string
Name of the resource.
- Org
Id string Unique identifier of the Organization.
- Project
Id string Unique identifier of the Project.
- List<string>
Tags to associate with the resource. Tags should be in the form
name:value
.
- Identifier string
Unique identifier of the resource.
- Cross
Account AwsAccess Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- Description string
Description of the resource.
- Inherit
From AwsDelegate Connector Inherit From Delegate Args Inherit credentials from the delegate.
- Irsa
Aws
Connector Irsa Args Use IAM role for service accounts.
- Manual
Aws
Connector Manual Args Use IAM role for service accounts.
- Name string
Name of the resource.
- Org
Id string Unique identifier of the Organization.
- Project
Id string Unique identifier of the Project.
- []string
Tags to associate with the resource. Tags should be in the form
name:value
.
- identifier String
Unique identifier of the resource.
- cross
Account AwsAccess Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- description String
Description of the resource.
- inherit
From AwsDelegate Connector Inherit From Delegate Args Inherit credentials from the delegate.
- irsa
Aws
Connector Irsa Args Use IAM role for service accounts.
- manual
Aws
Connector Manual Args Use IAM role for service accounts.
- name String
Name of the resource.
- org
Id String Unique identifier of the Organization.
- project
Id String Unique identifier of the Project.
- List<String>
Tags to associate with the resource. Tags should be in the form
name:value
.
- identifier string
Unique identifier of the resource.
- cross
Account AwsAccess Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- description string
Description of the resource.
- inherit
From AwsDelegate Connector Inherit From Delegate Args Inherit credentials from the delegate.
- irsa
Aws
Connector Irsa Args Use IAM role for service accounts.
- manual
Aws
Connector Manual Args Use IAM role for service accounts.
- name string
Name of the resource.
- org
Id string Unique identifier of the Organization.
- project
Id string Unique identifier of the Project.
- string[]
Tags to associate with the resource. Tags should be in the form
name:value
.
- identifier str
Unique identifier of the resource.
- cross_
account_ Awsaccess Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- description str
Description of the resource.
- inherit_
from_ Awsdelegate Connector Inherit From Delegate Args Inherit credentials from the delegate.
- irsa
Aws
Connector Irsa Args Use IAM role for service accounts.
- manual
Aws
Connector Manual Args Use IAM role for service accounts.
- name str
Name of the resource.
- org_
id str Unique identifier of the Organization.
- project_
id str Unique identifier of the Project.
- Sequence[str]
Tags to associate with the resource. Tags should be in the form
name:value
.
- identifier String
Unique identifier of the resource.
- cross
Account Property MapAccess Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- description String
Description of the resource.
- inherit
From Property MapDelegate Inherit credentials from the delegate.
- irsa Property Map
Use IAM role for service accounts.
- manual Property Map
Use IAM role for service accounts.
- name String
Name of the resource.
- org
Id String Unique identifier of the Organization.
- project
Id String Unique identifier of the Project.
- List<String>
Tags to associate with the resource. Tags should be in the form
name:value
.
Outputs
All input properties are implicitly available as output properties. Additionally, the AwsConnector resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing AwsConnector Resource
Get an existing AwsConnector resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AwsConnectorState, opts?: CustomResourceOptions): AwsConnector
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cross_account_access: Optional[AwsConnectorCrossAccountAccessArgs] = None,
description: Optional[str] = None,
identifier: Optional[str] = None,
inherit_from_delegate: Optional[AwsConnectorInheritFromDelegateArgs] = None,
irsa: Optional[AwsConnectorIrsaArgs] = None,
manual: Optional[AwsConnectorManualArgs] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None) -> AwsConnector
func GetAwsConnector(ctx *Context, name string, id IDInput, state *AwsConnectorState, opts ...ResourceOption) (*AwsConnector, error)
public static AwsConnector Get(string name, Input<string> id, AwsConnectorState? state, CustomResourceOptions? opts = null)
public static AwsConnector get(String name, Output<String> id, AwsConnectorState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cross
Account Lbrlabs.Access Pulumi Package. Harness. Platform. Inputs. Aws Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- Description string
Description of the resource.
- Identifier string
Unique identifier of the resource.
- Inherit
From Lbrlabs.Delegate Pulumi Package. Harness. Platform. Inputs. Aws Connector Inherit From Delegate Args Inherit credentials from the delegate.
- Irsa
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Aws Connector Irsa Args Use IAM role for service accounts.
- Manual
Lbrlabs.
Pulumi Package. Harness. Platform. Inputs. Aws Connector Manual Args Use IAM role for service accounts.
- Name string
Name of the resource.
- Org
Id string Unique identifier of the Organization.
- Project
Id string Unique identifier of the Project.
- List<string>
Tags to associate with the resource. Tags should be in the form
name:value
.
- Cross
Account AwsAccess Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- Description string
Description of the resource.
- Identifier string
Unique identifier of the resource.
- Inherit
From AwsDelegate Connector Inherit From Delegate Args Inherit credentials from the delegate.
- Irsa
Aws
Connector Irsa Args Use IAM role for service accounts.
- Manual
Aws
Connector Manual Args Use IAM role for service accounts.
- Name string
Name of the resource.
- Org
Id string Unique identifier of the Organization.
- Project
Id string Unique identifier of the Project.
- []string
Tags to associate with the resource. Tags should be in the form
name:value
.
- cross
Account AwsAccess Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- description String
Description of the resource.
- identifier String
Unique identifier of the resource.
- inherit
From AwsDelegate Connector Inherit From Delegate Args Inherit credentials from the delegate.
- irsa
Aws
Connector Irsa Args Use IAM role for service accounts.
- manual
Aws
Connector Manual Args Use IAM role for service accounts.
- name String
Name of the resource.
- org
Id String Unique identifier of the Organization.
- project
Id String Unique identifier of the Project.
- List<String>
Tags to associate with the resource. Tags should be in the form
name:value
.
- cross
Account AwsAccess Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- description string
Description of the resource.
- identifier string
Unique identifier of the resource.
- inherit
From AwsDelegate Connector Inherit From Delegate Args Inherit credentials from the delegate.
- irsa
Aws
Connector Irsa Args Use IAM role for service accounts.
- manual
Aws
Connector Manual Args Use IAM role for service accounts.
- name string
Name of the resource.
- org
Id string Unique identifier of the Organization.
- project
Id string Unique identifier of the Project.
- string[]
Tags to associate with the resource. Tags should be in the form
name:value
.
- cross_
account_ Awsaccess Connector Cross Account Access Args Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- description str
Description of the resource.
- identifier str
Unique identifier of the resource.
- inherit_
from_ Awsdelegate Connector Inherit From Delegate Args Inherit credentials from the delegate.
- irsa
Aws
Connector Irsa Args Use IAM role for service accounts.
- manual
Aws
Connector Manual Args Use IAM role for service accounts.
- name str
Name of the resource.
- org_
id str Unique identifier of the Organization.
- project_
id str Unique identifier of the Project.
- Sequence[str]
Tags to associate with the resource. Tags should be in the form
name:value
.
- cross
Account Property MapAccess Select this option if you want to use one AWS account for the connection, but you want to deploy or build in a different AWS account. In this scenario, the AWS account used for AWS access in Credentials will assume the IAM role you specify in Cross-account role ARN setting. This option uses the AWS Security Token Service (STS) feature.
- description String
Description of the resource.
- identifier String
Unique identifier of the resource.
- inherit
From Property MapDelegate Inherit credentials from the delegate.
- irsa Property Map
Use IAM role for service accounts.
- manual Property Map
Use IAM role for service accounts.
- name String
Name of the resource.
- org
Id String Unique identifier of the Organization.
- project
Id String Unique identifier of the Project.
- List<String>
Tags to associate with the resource. Tags should be in the form
name:value
.
Supporting Types
AwsConnectorCrossAccountAccess
- Role
Arn string The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
- External
Id string If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
- Role
Arn string The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
- External
Id string If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
- role
Arn String The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
- external
Id String If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
- role
Arn string The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
- external
Id string If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
- role_
arn str The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
- external_
id str If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
- role
Arn String The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
- external
Id String If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.
AwsConnectorInheritFromDelegate
- Delegate
Selectors List<string> The delegates to inherit the credentials from.
- Delegate
Selectors []string The delegates to inherit the credentials from.
- delegate
Selectors List<String> The delegates to inherit the credentials from.
- delegate
Selectors string[] The delegates to inherit the credentials from.
- delegate_
selectors Sequence[str] The delegates to inherit the credentials from.
- delegate
Selectors List<String> The delegates to inherit the credentials from.
AwsConnectorIrsa
- Delegate
Selectors List<string> The delegates to inherit the credentials from.
- Delegate
Selectors []string The delegates to inherit the credentials from.
- delegate
Selectors List<String> The delegates to inherit the credentials from.
- delegate
Selectors string[] The delegates to inherit the credentials from.
- delegate_
selectors Sequence[str] The delegates to inherit the credentials from.
- delegate
Selectors List<String> The delegates to inherit the credentials from.
AwsConnectorManual
- Secret
Key stringRef Reference to the Harness secret containing the aws secret key.
- Access
Key string AWS access key.
- Access
Key stringRef Reference to the Harness secret containing the aws access key.
- Delegate
Selectors List<string> Connect only use delegates with these tags.
- Secret
Key stringRef Reference to the Harness secret containing the aws secret key.
- Access
Key string AWS access key.
- Access
Key stringRef Reference to the Harness secret containing the aws access key.
- Delegate
Selectors []string Connect only use delegates with these tags.
- secret
Key StringRef Reference to the Harness secret containing the aws secret key.
- access
Key String AWS access key.
- access
Key StringRef Reference to the Harness secret containing the aws access key.
- delegate
Selectors List<String> Connect only use delegates with these tags.
- secret
Key stringRef Reference to the Harness secret containing the aws secret key.
- access
Key string AWS access key.
- access
Key stringRef Reference to the Harness secret containing the aws access key.
- delegate
Selectors string[] Connect only use delegates with these tags.
- secret_
key_ strref Reference to the Harness secret containing the aws secret key.
- access_
key str AWS access key.
- access_
key_ strref Reference to the Harness secret containing the aws access key.
- delegate_
selectors Sequence[str] Connect only use delegates with these tags.
- secret
Key StringRef Reference to the Harness secret containing the aws secret key.
- access
Key String AWS access key.
- access
Key StringRef Reference to the Harness secret containing the aws access key.
- delegate
Selectors List<String> Connect only use delegates with these tags.
Package Details
- Repository
- harness lbrlabs/pulumi-harness
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
harness
Terraform Provider.