@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
239 lines • 8.05 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.VirtualNode = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides an AWS App Mesh virtual node resource.
*
* ## Breaking Changes
*
* Because of backward incompatible API changes (read [here](https://github.com/awslabs/aws-app-mesh-examples/issues/92)), `aws.appmesh.VirtualNode` resource definitions created with provider versions earlier than v2.3.0 will need to be modified:
*
* * Rename the `serviceName` attribute of the `dns` object to `hostname`.
*
* * Replace the `backends` attribute of the `spec` object with one or more `backend` configuration blocks,
* setting `virtualServiceName` to the name of the service.
*
* The state associated with existing resources will automatically be migrated.
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const serviceb1 = new aws.appmesh.VirtualNode("serviceb1", {
* name: "serviceBv1",
* meshName: simple.id,
* spec: {
* backends: [{
* virtualService: {
* virtualServiceName: "servicea.simpleapp.local",
* },
* }],
* listeners: [{
* portMapping: {
* port: 8080,
* protocol: "http",
* },
* }],
* serviceDiscovery: {
* dns: {
* hostname: "serviceb.simpleapp.local",
* },
* },
* },
* });
* ```
*
* ### AWS Cloud Map Service Discovery
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.servicediscovery.HttpNamespace("example", {name: "example-ns"});
* const serviceb1 = new aws.appmesh.VirtualNode("serviceb1", {
* name: "serviceBv1",
* meshName: simple.id,
* spec: {
* backends: [{
* virtualService: {
* virtualServiceName: "servicea.simpleapp.local",
* },
* }],
* listeners: [{
* portMapping: {
* port: 8080,
* protocol: "http",
* },
* }],
* serviceDiscovery: {
* awsCloudMap: {
* attributes: {
* stack: "blue",
* },
* serviceName: "serviceb1",
* namespaceName: example.name,
* },
* },
* },
* });
* ```
*
* ### Listener Health Check
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const serviceb1 = new aws.appmesh.VirtualNode("serviceb1", {
* name: "serviceBv1",
* meshName: simple.id,
* spec: {
* backends: [{
* virtualService: {
* virtualServiceName: "servicea.simpleapp.local",
* },
* }],
* listeners: [{
* portMapping: {
* port: 8080,
* protocol: "http",
* },
* healthCheck: {
* protocol: "http",
* path: "/ping",
* healthyThreshold: 2,
* unhealthyThreshold: 2,
* timeoutMillis: 2000,
* intervalMillis: 5000,
* },
* }],
* serviceDiscovery: {
* dns: {
* hostname: "serviceb.simpleapp.local",
* },
* },
* },
* });
* ```
*
* ### Logging
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const serviceb1 = new aws.appmesh.VirtualNode("serviceb1", {
* name: "serviceBv1",
* meshName: simple.id,
* spec: {
* backends: [{
* virtualService: {
* virtualServiceName: "servicea.simpleapp.local",
* },
* }],
* listeners: [{
* portMapping: {
* port: 8080,
* protocol: "http",
* },
* }],
* serviceDiscovery: {
* dns: {
* hostname: "serviceb.simpleapp.local",
* },
* },
* logging: {
* accessLog: {
* file: {
* path: "/dev/stdout",
* },
* },
* },
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import App Mesh virtual nodes using `mesh_name` together with the virtual node's `name`. For example:
*
* ```sh
* $ pulumi import aws:appmesh/virtualNode:VirtualNode serviceb1 simpleapp/serviceBv1
* ```
*/
class VirtualNode extends pulumi.CustomResource {
/**
* Get an existing VirtualNode resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new VirtualNode(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of VirtualNode. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === VirtualNode.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["arn"] = state?.arn;
resourceInputs["createdDate"] = state?.createdDate;
resourceInputs["lastUpdatedDate"] = state?.lastUpdatedDate;
resourceInputs["meshName"] = state?.meshName;
resourceInputs["meshOwner"] = state?.meshOwner;
resourceInputs["name"] = state?.name;
resourceInputs["region"] = state?.region;
resourceInputs["resourceOwner"] = state?.resourceOwner;
resourceInputs["spec"] = state?.spec;
resourceInputs["tags"] = state?.tags;
resourceInputs["tagsAll"] = state?.tagsAll;
}
else {
const args = argsOrState;
if (args?.meshName === undefined && !opts.urn) {
throw new Error("Missing required property 'meshName'");
}
if (args?.spec === undefined && !opts.urn) {
throw new Error("Missing required property 'spec'");
}
resourceInputs["meshName"] = args?.meshName;
resourceInputs["meshOwner"] = args?.meshOwner;
resourceInputs["name"] = args?.name;
resourceInputs["region"] = args?.region;
resourceInputs["spec"] = args?.spec;
resourceInputs["tags"] = args?.tags;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["createdDate"] = undefined /*out*/;
resourceInputs["lastUpdatedDate"] = undefined /*out*/;
resourceInputs["resourceOwner"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(VirtualNode.__pulumiType, name, resourceInputs, opts);
}
}
exports.VirtualNode = VirtualNode;
/** @internal */
VirtualNode.__pulumiType = 'aws:appmesh/virtualNode:VirtualNode';
//# sourceMappingURL=virtualNode.js.map