Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. codestarconnections
  5. Host
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.codestarconnections.Host

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.codestarconnections.Host("example", {
    name: "example-host",
    providerEndpoint: "https://example.com",
    providerType: "GitHubEnterpriseServer",
});

    import pulumi
import pulumi_aws as aws

example = aws.codestarconnections.Host("example",
    name="example-host",
    provider_endpoint="https://example.com",
    provider_type="GitHubEnterpriseServer")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name:             pulumi.String("example-host"),
			ProviderEndpoint: pulumi.String("https://example.com"),
			ProviderType:     pulumi.String("GitHubEnterpriseServer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

});

    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()
            .name("example-host")
            .providerEndpoint("https://example.com")
            .providerType("GitHubEnterpriseServer")
            .build());

    }
}

    resources:
  example:
    type: aws:codestarconnections:Host
    properties:
      name: example-host
      providerEndpoint: https://example.com
      providerType: GitHubEnterpriseServer

    Create Host Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Host(name: string, args: HostArgs, opts?: CustomResourceOptions);
    @overload
def Host(resource_name: str,
         args: HostArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Host(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         provider_endpoint: Optional[str] = None,
         provider_type: Optional[str] = None,
         name: Optional[str] = None,
         vpc_configuration: Optional[HostVpcConfigurationArgs] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var hostResource = new Aws.CodeStarConnections.Host("hostResource", new()
{
    ProviderEndpoint = "string",
    ProviderType = "string",
    Name = "string",
    VpcConfiguration = new Aws.CodeStarConnections.Inputs.HostVpcConfigurationArgs
    {
        SecurityGroupIds = new[]
        {
            "string",
        },
        SubnetIds = new[]
        {
            "string",
        },
        VpcId = "string",
        TlsCertificate = "string",
    },
});

    example, err := codestarconnections.NewHost(ctx, "hostResource", &codestarconnections.HostArgs{
	ProviderEndpoint: pulumi.String("string"),
	ProviderType:     pulumi.String("string"),
	Name:             pulumi.String("string"),
	VpcConfiguration: &codestarconnections.HostVpcConfigurationArgs{
		SecurityGroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		SubnetIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		VpcId:          pulumi.String("string"),
		TlsCertificate: pulumi.String("string"),
	},
})

    var hostResource = new Host("hostResource", HostArgs.builder()
    .providerEndpoint("string")
    .providerType("string")
    .name("string")
    .vpcConfiguration(HostVpcConfigurationArgs.builder()
        .securityGroupIds("string")
        .subnetIds("string")
        .vpcId("string")
        .tlsCertificate("string")
        .build())
    .build());

    host_resource = aws.codestarconnections.Host("hostResource",
    provider_endpoint="string",
    provider_type="string",
    name="string",
    vpc_configuration={
        "security_group_ids": ["string"],
        "subnet_ids": ["string"],
        "vpc_id": "string",
        "tls_certificate": "string",
    })

    const hostResource = new aws.codestarconnections.Host("hostResource", {
    providerEndpoint: "string",
    providerType: "string",
    name: "string",
    vpcConfiguration: {
        securityGroupIds: ["string"],
        subnetIds: ["string"],
        vpcId: "string",
        tlsCertificate: "string",
    },
});

    type: aws:codestarconnections:Host
properties:
    name: string
    providerEndpoint: string
    providerType: string
    vpcConfiguration:
        securityGroupIds:
            - string
        subnetIds:
            - string
        tlsCertificate: string
        vpcId: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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 HostVpcConfiguration
    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 HostVpcConfiguration
    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 HostVpcConfiguration
    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 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 HostVpcConfiguration
    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 HostVpcConfiguration
    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 HostVpcConfiguration
    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, HostVpcConfigurationArgs

    SecurityGroupIds List<string>
    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
    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>
    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[]
    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]
    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>
    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

    Using pulumi import, import CodeStar Host using the ARN. For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws