Harness v0.0.5, Oct 31 22

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.
CrossAccountAccess Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsConnectorCrossAccountAccessArgs: 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.
InheritFromDelegate Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
Irsa Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsConnectorIrsaArgs: Use IAM role for service accounts.
Manual Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsConnectorManualArgs: Use IAM role for service accounts.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags List<string>: Tags to associate with the resource. Tags should be in the form name:value.

Identifier string: Unique identifier of the resource.
CrossAccountAccess AwsConnectorCrossAccountAccessArgs: 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.
InheritFromDelegate AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
Irsa AwsConnectorIrsaArgs: Use IAM role for service accounts.
Manual AwsConnectorManualArgs: Use IAM role for service accounts.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags []string: Tags to associate with the resource. Tags should be in the form name:value.

identifier String: Unique identifier of the resource.
crossAccountAccess AwsConnectorCrossAccountAccessArgs: 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.
inheritFromDelegate AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
irsa AwsConnectorIrsaArgs: Use IAM role for service accounts.
manual AwsConnectorManualArgs: Use IAM role for service accounts.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.

identifier string: Unique identifier of the resource.
crossAccountAccess AwsConnectorCrossAccountAccessArgs: 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.
inheritFromDelegate AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
irsa AwsConnectorIrsaArgs: Use IAM role for service accounts.
manual AwsConnectorManualArgs: Use IAM role for service accounts.
name string: Name of the resource.
orgId string: Unique identifier of the Organization.
projectId string: Unique identifier of the Project.
tags string[]: Tags to associate with the resource. Tags should be in the form name:value.

identifier str: Unique identifier of the resource.
cross_account_access AwsConnectorCrossAccountAccessArgs: 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_delegate AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
irsa AwsConnectorIrsaArgs: Use IAM role for service accounts.
manual AwsConnectorManualArgs: 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.
tags Sequence[str]: Tags to associate with the resource. Tags should be in the form name:value.

identifier String: Unique identifier of the resource.
crossAccountAccess Property Map: 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.
inheritFromDelegate Property Map: 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.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags 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.

The following state arguments are supported:

CrossAccountAccess Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsConnectorCrossAccountAccessArgs: 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.
InheritFromDelegate Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
Irsa Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsConnectorIrsaArgs: Use IAM role for service accounts.
Manual Lbrlabs.PulumiPackage.Harness.Platform.Inputs.AwsConnectorManualArgs: Use IAM role for service accounts.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags List<string>: Tags to associate with the resource. Tags should be in the form name:value.

CrossAccountAccess AwsConnectorCrossAccountAccessArgs: 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.
InheritFromDelegate AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
Irsa AwsConnectorIrsaArgs: Use IAM role for service accounts.
Manual AwsConnectorManualArgs: Use IAM role for service accounts.
Name string: Name of the resource.
OrgId string: Unique identifier of the Organization.
ProjectId string: Unique identifier of the Project.
Tags []string: Tags to associate with the resource. Tags should be in the form name:value.

crossAccountAccess AwsConnectorCrossAccountAccessArgs: 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.
inheritFromDelegate AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
irsa AwsConnectorIrsaArgs: Use IAM role for service accounts.
manual AwsConnectorManualArgs: Use IAM role for service accounts.
name String: Name of the resource.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.

crossAccountAccess AwsConnectorCrossAccountAccessArgs: 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.
inheritFromDelegate AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
irsa AwsConnectorIrsaArgs: Use IAM role for service accounts.
manual AwsConnectorManualArgs: Use IAM role for service accounts.
name string: Name of the resource.
orgId string: Unique identifier of the Organization.
projectId string: Unique identifier of the Project.
tags string[]: Tags to associate with the resource. Tags should be in the form name:value.

cross_account_access AwsConnectorCrossAccountAccessArgs: 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_delegate AwsConnectorInheritFromDelegateArgs: Inherit credentials from the delegate.
irsa AwsConnectorIrsaArgs: Use IAM role for service accounts.
manual AwsConnectorManualArgs: 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.
tags Sequence[str]: Tags to associate with the resource. Tags should be in the form name:value.

crossAccountAccess Property Map: 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.
inheritFromDelegate Property Map: 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.
orgId String: Unique identifier of the Organization.
projectId String: Unique identifier of the Project.
tags List<String>: Tags to associate with the resource. Tags should be in the form name:value.

Supporting Types

AwsConnectorCrossAccountAccess

RoleArn string: The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
ExternalId string: If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.

RoleArn string: The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
ExternalId string: If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.

roleArn String: The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
externalId String: If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.

roleArn string: The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
externalId 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.

roleArn String: The Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target AWS account.
externalId String: If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.

AwsConnectorInheritFromDelegate

DelegateSelectors List<string>: The delegates to inherit the credentials from.

DelegateSelectors []string: The delegates to inherit the credentials from.

delegateSelectors List<String>: The delegates to inherit the credentials from.

delegateSelectors string[]: The delegates to inherit the credentials from.

delegate_selectors Sequence[str]: The delegates to inherit the credentials from.

delegateSelectors List<String>: The delegates to inherit the credentials from.

AwsConnectorIrsa

DelegateSelectors List<string>: The delegates to inherit the credentials from.

DelegateSelectors []string: The delegates to inherit the credentials from.

delegateSelectors List<String>: The delegates to inherit the credentials from.

delegateSelectors string[]: The delegates to inherit the credentials from.

delegate_selectors Sequence[str]: The delegates to inherit the credentials from.

delegateSelectors List<String>: The delegates to inherit the credentials from.

AwsConnectorManual

SecretKeyRef string: Reference to the Harness secret containing the aws secret key.
AccessKey string: AWS access key.
AccessKeyRef string: Reference to the Harness secret containing the aws access key.
DelegateSelectors List<string>: Connect only use delegates with these tags.

SecretKeyRef string: Reference to the Harness secret containing the aws secret key.
AccessKey string: AWS access key.
AccessKeyRef string: Reference to the Harness secret containing the aws access key.
DelegateSelectors []string: Connect only use delegates with these tags.

secretKeyRef String: Reference to the Harness secret containing the aws secret key.
accessKey String: AWS access key.
accessKeyRef String: Reference to the Harness secret containing the aws access key.
delegateSelectors List<String>: Connect only use delegates with these tags.

secretKeyRef string: Reference to the Harness secret containing the aws secret key.
accessKey string: AWS access key.
accessKeyRef string: Reference to the Harness secret containing the aws access key.
delegateSelectors string[]: Connect only use delegates with these tags.

secret_key_ref str: Reference to the Harness secret containing the aws secret key.
access_key str: AWS access key.
access_key_ref str: Reference to the Harness secret containing the aws access key.
delegate_selectors Sequence[str]: Connect only use delegates with these tags.

secretKeyRef String: Reference to the Harness secret containing the aws secret key.
accessKey String: AWS access key.
accessKeyRef String: Reference to the Harness secret containing the aws access key.
delegateSelectors 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.