AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

Host

Provides a CodeStar Host.

NOTE: The aws.codestarconnections.Host resource is created in the state PENDING. Authentication with the host provider must be completed in the AWS Console. For more information visit Set up a pending host.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.CodeStarConnections.Host("example", new()
    {
        ProviderEndpoint = "https://example.com",
        ProviderType = "GitHubEnterpriseServer",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/codestarconnections"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codestarconnections.NewHost(ctx, "example", &codestarconnections.HostArgs{
			ProviderEndpoint: pulumi.String("https://example.com"),
			ProviderType:     pulumi.String("GitHubEnterpriseServer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.codestarconnections.Host;
import com.pulumi.aws.codestarconnections.HostArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Host("example", HostArgs.builder()        
            .providerEndpoint("https://example.com")
            .providerType("GitHubEnterpriseServer")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.codestarconnections.Host("example",
    provider_endpoint="https://example.com",
    provider_type="GitHubEnterpriseServer")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.codestarconnections.Host("example", {
    providerEndpoint: "https://example.com",
    providerType: "GitHubEnterpriseServer",
});
resources:
  example:
    type: aws:codestarconnections:Host
    properties:
      providerEndpoint: https://example.com
      providerType: GitHubEnterpriseServer

Create a Host Resource

new Host(name: string, args: HostArgs, opts?: CustomResourceOptions);
@overload
def Host(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         name: Optional[str] = None,
         provider_endpoint: Optional[str] = None,
         provider_type: Optional[str] = None,
         vpc_configuration: Optional[HostVpcConfigurationArgs] = None)
@overload
def Host(resource_name: str,
         args: HostArgs,
         opts: Optional[ResourceOptions] = None)
func NewHost(ctx *Context, name string, args HostArgs, opts ...ResourceOption) (*Host, error)
public Host(string name, HostArgs args, CustomResourceOptions? opts = null)
public Host(String name, HostArgs args)
public Host(String name, HostArgs args, CustomResourceOptions options)
type: aws:codestarconnections:Host
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args HostArgs
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 HostArgs
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 HostArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args HostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args HostArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Host 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 Host resource accepts the following input properties:

ProviderEndpoint string

The endpoint of the infrastructure to be represented by the host after it is created.

ProviderType string

The name of the external provider where your third-party code repository is configured.

Name string

The name of the host to be created. The name must be unique in the calling AWS account.

VpcConfiguration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

ProviderEndpoint string

The endpoint of the infrastructure to be represented by the host after it is created.

ProviderType string

The name of the external provider where your third-party code repository is configured.

Name string

The name of the host to be created. The name must be unique in the calling AWS account.

VpcConfiguration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

providerEndpoint String

The endpoint of the infrastructure to be represented by the host after it is created.

providerType String

The name of the external provider where your third-party code repository is configured.

name String

The name of the host to be created. The name must be unique in the calling AWS account.

vpcConfiguration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

providerEndpoint string

The endpoint of the infrastructure to be represented by the host after it is created.

providerType string

The name of the external provider where your third-party code repository is configured.

name string

The name of the host to be created. The name must be unique in the calling AWS account.

vpcConfiguration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

provider_endpoint str

The endpoint of the infrastructure to be represented by the host after it is created.

provider_type str

The name of the external provider where your third-party code repository is configured.

name str

The name of the host to be created. The name must be unique in the calling AWS account.

vpc_configuration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

providerEndpoint String

The endpoint of the infrastructure to be represented by the host after it is created.

providerType String

The name of the external provider where your third-party code repository is configured.

name String

The name of the host to be created. The name must be unique in the calling AWS account.

vpcConfiguration Property Map

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

Outputs

All input properties are implicitly available as output properties. Additionally, the Host resource produces the following output properties:

Arn string

The CodeStar Host ARN.

Id string

The provider-assigned unique ID for this managed resource.

Status string

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

Arn string

The CodeStar Host ARN.

Id string

The provider-assigned unique ID for this managed resource.

Status string

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

arn String

The CodeStar Host ARN.

id String

The provider-assigned unique ID for this managed resource.

status String

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

arn string

The CodeStar Host ARN.

id string

The provider-assigned unique ID for this managed resource.

status string

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

arn str

The CodeStar Host ARN.

id str

The provider-assigned unique ID for this managed resource.

status str

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

arn String

The CodeStar Host ARN.

id String

The provider-assigned unique ID for this managed resource.

status String

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

Look up an Existing Host Resource

Get an existing Host 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?: HostState, opts?: CustomResourceOptions): Host
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        name: Optional[str] = None,
        provider_endpoint: Optional[str] = None,
        provider_type: Optional[str] = None,
        status: Optional[str] = None,
        vpc_configuration: Optional[HostVpcConfigurationArgs] = None) -> Host
func GetHost(ctx *Context, name string, id IDInput, state *HostState, opts ...ResourceOption) (*Host, error)
public static Host Get(string name, Input<string> id, HostState? state, CustomResourceOptions? opts = null)
public static Host get(String name, Output<String> id, HostState 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:
Arn string

The CodeStar Host ARN.

Name string

The name of the host to be created. The name must be unique in the calling AWS account.

ProviderEndpoint string

The endpoint of the infrastructure to be represented by the host after it is created.

ProviderType string

The name of the external provider where your third-party code repository is configured.

Status string

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

VpcConfiguration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

Arn string

The CodeStar Host ARN.

Name string

The name of the host to be created. The name must be unique in the calling AWS account.

ProviderEndpoint string

The endpoint of the infrastructure to be represented by the host after it is created.

ProviderType string

The name of the external provider where your third-party code repository is configured.

Status string

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

VpcConfiguration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

arn String

The CodeStar Host ARN.

name String

The name of the host to be created. The name must be unique in the calling AWS account.

providerEndpoint String

The endpoint of the infrastructure to be represented by the host after it is created.

providerType String

The name of the external provider where your third-party code repository is configured.

status String

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

vpcConfiguration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

arn string

The CodeStar Host ARN.

name string

The name of the host to be created. The name must be unique in the calling AWS account.

providerEndpoint string

The endpoint of the infrastructure to be represented by the host after it is created.

providerType string

The name of the external provider where your third-party code repository is configured.

status string

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

vpcConfiguration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

arn str

The CodeStar Host ARN.

name str

The name of the host to be created. The name must be unique in the calling AWS account.

provider_endpoint str

The endpoint of the infrastructure to be represented by the host after it is created.

provider_type str

The name of the external provider where your third-party code repository is configured.

status str

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

vpc_configuration HostVpcConfigurationArgs

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

arn String

The CodeStar Host ARN.

name String

The name of the host to be created. The name must be unique in the calling AWS account.

providerEndpoint String

The endpoint of the infrastructure to be represented by the host after it is created.

providerType String

The name of the external provider where your third-party code repository is configured.

status String

The CodeStar Host status. Possible values are PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

vpcConfiguration Property Map

The VPC configuration to be provisioned for the host. A VPC must be configured, and the infrastructure to be represented by the host must already be connected to the VPC.

Supporting Types

HostVpcConfiguration

SecurityGroupIds List<string>

he ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

SubnetIds List<string>

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

VpcId string

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

TlsCertificate string

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

SecurityGroupIds []string

he ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

SubnetIds []string

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

VpcId string

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

TlsCertificate string

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

securityGroupIds List<String>

he ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

subnetIds List<String>

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

vpcId String

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

tlsCertificate String

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

securityGroupIds string[]

he ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

subnetIds string[]

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

vpcId string

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

tlsCertificate string

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

security_group_ids Sequence[str]

he ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

subnet_ids Sequence[str]

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

vpc_id str

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

tls_certificate str

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

securityGroupIds List<String>

he ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

subnetIds List<String>

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

vpcId String

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

tlsCertificate String

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

Import

CodeStar Host can be imported using the ARN, e.g.,

 $ pulumi import aws:codestarconnections/host:Host example-host arn:aws:codestar-connections:us-west-1:0123456789:host/79d4d357-a2ee-41e4-b350-2fe39ae59448

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.