Host class
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")
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_codestarconnections_host" "example" {
name = "example-host"
provider_endpoint = "https://example.com"
provider_type = "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.ArrayList;
import java.util.Arrays;
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
Import
Identity Schema
Required
arn(String) ARN of the CodeStar connections host.
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
Constructors
- Host(String name, {HostArgs? args, CustomResourceOptions? options})
-
Creates a new Host.
nameThe Pulumi resource name.argsArguments used to configure this Host. The set of arguments for Host.optionsResource options controlling this resource's behavior. - Host.reference(String urn)
- Creates a typed reference to an existing Host resource.
Properties
-
arn
↔ Output<
String> -
The CodeStar Host ARN.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
The name of the host to be created. The name must be unique in the calling AWS account.
latefinal
-
providerEndpoint
↔ Output<
String> -
The endpoint of the infrastructure to be represented by the host after it is created.
latefinal
-
providerType
↔ Output<
String> -
The name of the external provider where your third-party code repository is configured.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
↔ Output<
String> -
The CodeStar Host status. Possible values are
PENDING,AVAILABLE,VPC_CONFIG_DELETING,VPC_CONFIG_INITIALIZING, andVPC_CONFIG_FAILED_INITIALIZATION.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcConfiguration
↔ Output<
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.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited