This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

appmesh¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.appmesh.Mesh(resource_name, opts=None, name=None, spec=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides an AWS App Mesh service mesh resource.

import pulumi
import pulumi_aws as aws

simple = aws.appmesh.Mesh("simple")

import pulumi
import pulumi_aws as aws

simple = aws.appmesh.Mesh("simple", spec={
    "egressFilter": {
        "type": "ALLOW_ALL",
    },
})

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name to use for the service mesh.
spec (pulumi.Input[dict]) – The service mesh specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The spec object supports the following:

egressFilter (pulumi.Input[dict]) - The egress filter rules for the service mesh.
- type (pulumi.Input[str]) - The egress filter type. By default, the type is DROP_ALL. Valid values are ALLOW_ALL and DROP_ALL.

arn: pulumi.Output[str] = None¶: The ARN of the service mesh.

created_date: pulumi.Output[str] = None¶: The creation date of the service mesh.

last_updated_date: pulumi.Output[str] = None¶: The last update date of the service mesh.

name: pulumi.Output[str] = None¶: The name to use for the service mesh.

spec: pulumi.Output[dict] = None¶

The service mesh specification to apply.

egressFilter (dict) - The egress filter rules for the service mesh.
- type (str) - The egress filter type. By default, the type is DROP_ALL. Valid values are ALLOW_ALL and DROP_ALL.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, created_date=None, last_updated_date=None, name=None, spec=None, tags=None)¶

Get an existing Mesh resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the service mesh.
created_date (pulumi.Input[str]) – The creation date of the service mesh.
last_updated_date (pulumi.Input[str]) – The last update date of the service mesh.
name (pulumi.Input[str]) – The name to use for the service mesh.
spec (pulumi.Input[dict]) – The service mesh specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The spec object supports the following:

egressFilter (pulumi.Input[dict]) - The egress filter rules for the service mesh.
- type (pulumi.Input[str]) - The egress filter type. By default, the type is DROP_ALL. Valid values are ALLOW_ALL and DROP_ALL.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.appmesh.Route(resource_name, opts=None, mesh_name=None, name=None, spec=None, tags=None, virtual_router_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides an AWS App Mesh route resource.

import pulumi
import pulumi_aws as aws

serviceb = aws.appmesh.Route("serviceb",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "httpRoute": {
            "action": {
                "weightedTarget": [
                    {
                        "virtualNode": aws_appmesh_virtual_node["serviceb1"]["name"],
                        "weight": 90,
                    },
                    {
                        "virtualNode": aws_appmesh_virtual_node["serviceb2"]["name"],
                        "weight": 10,
                    },
                ],
            },
            "match": {
                "prefix": "/",
            },
        },
    },
    virtual_router_name=aws_appmesh_virtual_router["serviceb"]["name"])

import pulumi
import pulumi_aws as aws

serviceb = aws.appmesh.Route("serviceb",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "httpRoute": {
            "action": {
                "weightedTarget": [{
                    "virtualNode": aws_appmesh_virtual_node["serviceb"]["name"],
                    "weight": 100,
                }],
            },
            "match": {
                "header": [{
                    "match": {
                        "prefix": "123",
                    },
                    "name": "clientRequestId",
                }],
                "method": "POST",
                "prefix": "/",
                "scheme": "https",
            },
        },
    },
    virtual_router_name=aws_appmesh_virtual_router["serviceb"]["name"])

import pulumi
import pulumi_aws as aws

serviceb = aws.appmesh.Route("serviceb",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "tcpRoute": {
            "action": {
                "weightedTarget": [{
                    "virtualNode": aws_appmesh_virtual_node["serviceb1"]["name"],
                    "weight": 100,
                }],
            },
        },
    },
    virtual_router_name=aws_appmesh_virtual_router["serviceb"]["name"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
mesh_name (pulumi.Input[str]) – The name of the service mesh in which to create the route.
name (pulumi.Input[str]) – The name to use for the route.
spec (pulumi.Input[dict]) – The route specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
virtual_router_name (pulumi.Input[str]) – The name of the virtual router in which to create the route.

The spec object supports the following:

httpRoute (pulumi.Input[dict]) - The HTTP routing information for the route.
- action (pulumi.Input[dict]) - The action to take if a match is determined.
  - weightedTargets (pulumi.Input[list]) - The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    - virtualNode (pulumi.Input[str]) - The virtual node to associate with the weighted target.
    - weight (pulumi.Input[float]) - The relative weight of the weighted target. An integer between 0 and 100.
- match (pulumi.Input[dict]) - The criteria for determining an HTTP request match.
  - headers (pulumi.Input[list]) - The client request headers to match on.
    - invert (pulumi.Input[bool]) - If true, the match is on the opposite of the match method and value. Default is false.
    - match (pulumi.Input[dict]) - The method and value to match the header value sent with a request. Specify one match method.
      - exact (pulumi.Input[str]) - The header value sent by the client must match the specified value exactly.
      - prefix (pulumi.Input[str]) - Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name.
      - range (pulumi.Input[dict]) - The object that specifies the range of numbers that the header value sent by the client must be included in.
        end (pulumi.Input[float]) - The end of the range.
        start (pulumi.Input[float]) - The start of the range.
      - regex (pulumi.Input[str]) - The header value sent by the client must include the specified characters.
      - suffix (pulumi.Input[str]) - The header value sent by the client must end with the specified characters.
    - name (pulumi.Input[str]) - A name for the HTTP header in the client request that will be matched on.
  - method (pulumi.Input[str]) - The client request header method to match on. Valid values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH.
  - prefix (pulumi.Input[str]) - Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name.
  - scheme (pulumi.Input[str]) - The client request header scheme to match on. Valid values: http, https.
priority (pulumi.Input[float]) - The priority for the route, between 0 and 1000. Routes are matched based on the specified value, where 0 is the highest priority.
tcpRoute (pulumi.Input[dict]) - The TCP routing information for the route.
- action (pulumi.Input[dict]) - The action to take if a match is determined.
  - weightedTargets (pulumi.Input[list]) - The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    - virtualNode (pulumi.Input[str]) - The virtual node to associate with the weighted target.
    - weight (pulumi.Input[float]) - The relative weight of the weighted target. An integer between 0 and 100.

arn: pulumi.Output[str] = None¶: The ARN of the route.

created_date: pulumi.Output[str] = None¶: The creation date of the route.

last_updated_date: pulumi.Output[str] = None¶: The last update date of the route.

mesh_name: pulumi.Output[str] = None¶: The name of the service mesh in which to create the route.

name: pulumi.Output[str] = None¶: The name to use for the route.

spec: pulumi.Output[dict] = None¶

The route specification to apply.

httpRoute (dict) - The HTTP routing information for the route.
- action (dict) - The action to take if a match is determined.
  - weightedTargets (list) - The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    - virtualNode (str) - The virtual node to associate with the weighted target.
    - weight (float) - The relative weight of the weighted target. An integer between 0 and 100.
- match (dict) - The criteria for determining an HTTP request match.
  - headers (list) - The client request headers to match on.
    - invert (bool) - If true, the match is on the opposite of the match method and value. Default is false.
    - match (dict) - The method and value to match the header value sent with a request. Specify one match method.
      - exact (str) - The header value sent by the client must match the specified value exactly.
      - prefix (str) - Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name.
      - range (dict) - The object that specifies the range of numbers that the header value sent by the client must be included in.
        end (float) - The end of the range.
        start (float) - The start of the range.
      - regex (str) - The header value sent by the client must include the specified characters.
      - suffix (str) - The header value sent by the client must end with the specified characters.
    - name (str) - A name for the HTTP header in the client request that will be matched on.
  - method (str) - The client request header method to match on. Valid values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH.
  - prefix (str) - Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name.
  - scheme (str) - The client request header scheme to match on. Valid values: http, https.
priority (float) - The priority for the route, between 0 and 1000. Routes are matched based on the specified value, where 0 is the highest priority.
tcpRoute (dict) - The TCP routing information for the route.
- action (dict) - The action to take if a match is determined.
  - weightedTargets (list) - The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    - virtualNode (str) - The virtual node to associate with the weighted target.
    - weight (float) - The relative weight of the weighted target. An integer between 0 and 100.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

virtual_router_name: pulumi.Output[str] = None¶: The name of the virtual router in which to create the route.

static get(resource_name, id, opts=None, arn=None, created_date=None, last_updated_date=None, mesh_name=None, name=None, spec=None, tags=None, virtual_router_name=None)¶

Get an existing Route resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the route.
created_date (pulumi.Input[str]) – The creation date of the route.
last_updated_date (pulumi.Input[str]) – The last update date of the route.
mesh_name (pulumi.Input[str]) – The name of the service mesh in which to create the route.
name (pulumi.Input[str]) – The name to use for the route.
spec (pulumi.Input[dict]) – The route specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
virtual_router_name (pulumi.Input[str]) – The name of the virtual router in which to create the route.

The spec object supports the following:

httpRoute (pulumi.Input[dict]) - The HTTP routing information for the route.
- action (pulumi.Input[dict]) - The action to take if a match is determined.
  - weightedTargets (pulumi.Input[list]) - The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    - virtualNode (pulumi.Input[str]) - The virtual node to associate with the weighted target.
    - weight (pulumi.Input[float]) - The relative weight of the weighted target. An integer between 0 and 100.
- match (pulumi.Input[dict]) - The criteria for determining an HTTP request match.
  - headers (pulumi.Input[list]) - The client request headers to match on.
    - invert (pulumi.Input[bool]) - If true, the match is on the opposite of the match method and value. Default is false.
    - match (pulumi.Input[dict]) - The method and value to match the header value sent with a request. Specify one match method.
      - exact (pulumi.Input[str]) - The header value sent by the client must match the specified value exactly.
      - prefix (pulumi.Input[str]) - Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name.
      - range (pulumi.Input[dict]) - The object that specifies the range of numbers that the header value sent by the client must be included in.
        end (pulumi.Input[float]) - The end of the range.
        start (pulumi.Input[float]) - The start of the range.
      - regex (pulumi.Input[str]) - The header value sent by the client must include the specified characters.
      - suffix (pulumi.Input[str]) - The header value sent by the client must end with the specified characters.
    - name (pulumi.Input[str]) - A name for the HTTP header in the client request that will be matched on.
  - method (pulumi.Input[str]) - The client request header method to match on. Valid values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH.
  - prefix (pulumi.Input[str]) - Specifies the path with which to match requests. This parameter must always start with /, which by itself matches all requests to the virtual router service name.
  - scheme (pulumi.Input[str]) - The client request header scheme to match on. Valid values: http, https.
priority (pulumi.Input[float]) - The priority for the route, between 0 and 1000. Routes are matched based on the specified value, where 0 is the highest priority.
tcpRoute (pulumi.Input[dict]) - The TCP routing information for the route.
- action (pulumi.Input[dict]) - The action to take if a match is determined.
  - weightedTargets (pulumi.Input[list]) - The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights with which to distribute traffic.
    - virtualNode (pulumi.Input[str]) - The virtual node to associate with the weighted target.
    - weight (pulumi.Input[float]) - The relative weight of the weighted target. An integer between 0 and 100.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.appmesh.VirtualNode(resource_name, opts=None, mesh_name=None, name=None, spec=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides an AWS App Mesh virtual node resource.

Because of backward incompatible API changes (read here), appmesh.VirtualNode resource definitions created with provider versions earlier than v2.3.0 will need to be modified:

Rename the service_name attribute of the dns object to hostname.
Replace the backends attribute of the spec object with one or more backend configuration blocks, setting virtual_service_name to the name of the service.

The state associated with existing resources will automatically be migrated.

import pulumi
import pulumi_aws as aws

serviceb1 = aws.appmesh.VirtualNode("serviceb1",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "backend": [{
            "virtualService": {
                "virtualServiceName": "servicea.simpleapp.local",
            },
        }],
        "listener": {
            "portMapping": {
                "port": 8080,
                "protocol": "http",
            },
        },
        "serviceDiscovery": {
            "dns": {
                "hostname": "serviceb.simpleapp.local",
            },
        },
    })

import pulumi
import pulumi_aws as aws

example = aws.servicediscovery.HttpNamespace("example")
serviceb1 = aws.appmesh.VirtualNode("serviceb1",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "backend": [{
            "virtualService": {
                "virtualServiceName": "servicea.simpleapp.local",
            },
        }],
        "listener": {
            "portMapping": {
                "port": 8080,
                "protocol": "http",
            },
        },
        "serviceDiscovery": {
            "awsCloudMap": {
                "attributes": {
                    "stack": "blue",
                },
                "namespaceName": example.name,
                "service_name": "serviceb1",
            },
        },
    })

import pulumi
import pulumi_aws as aws

serviceb1 = aws.appmesh.VirtualNode("serviceb1",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "backend": [{
            "virtualService": {
                "virtualServiceName": "servicea.simpleapp.local",
            },
        }],
        "listener": {
            "health_check": {
                "healthyThreshold": 2,
                "intervalMillis": 5000,
                "path": "/ping",
                "protocol": "http",
                "timeoutMillis": 2000,
                "unhealthyThreshold": 2,
            },
            "portMapping": {
                "port": 8080,
                "protocol": "http",
            },
        },
        "serviceDiscovery": {
            "dns": {
                "hostname": "serviceb.simpleapp.local",
            },
        },
    })

import pulumi
import pulumi_aws as aws

serviceb1 = aws.appmesh.VirtualNode("serviceb1",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "backend": [{
            "virtualService": {
                "virtualServiceName": "servicea.simpleapp.local",
            },
        }],
        "listener": {
            "portMapping": {
                "port": 8080,
                "protocol": "http",
            },
        },
        "logging": {
            "accessLog": {
                "file": {
                    "path": "/dev/stdout",
                },
            },
        },
        "serviceDiscovery": {
            "dns": {
                "hostname": "serviceb.simpleapp.local",
            },
        },
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
mesh_name (pulumi.Input[str]) – The name of the service mesh in which to create the virtual node.
name (pulumi.Input[str]) – The name to use for the virtual node.
spec (pulumi.Input[dict]) – The virtual node specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The spec object supports the following:

backends (pulumi.Input[list]) - The backends to which the virtual node is expected to send outbound traffic.
- virtualService (pulumi.Input[dict]) - Specifies a virtual service to use as a backend for a virtual node.
  - virtualServiceName (pulumi.Input[str]) - The name of the virtual service that is acting as a virtual node backend.
listener (pulumi.Input[dict]) - The listeners from which the virtual node is expected to receive inbound traffic.
- health_check (pulumi.Input[dict]) - The health check information for the listener.
  - healthyThreshold (pulumi.Input[float]) - The number of consecutive successful health checks that must occur before declaring listener healthy.
  - intervalMillis (pulumi.Input[float]) - The time period in milliseconds between each health check execution.
  - path (pulumi.Input[str]) - The destination path for the health check request. This is only required if the specified protocol is http.
  - port (pulumi.Input[float]) - The destination port for the health check request. This port must match the port defined in the port_mapping for the listener.
  - protocol (pulumi.Input[str]) - The protocol for the health check request. Valid values are http and tcp.
  - timeoutMillis (pulumi.Input[float]) - The amount of time to wait when receiving a response from the health check, in milliseconds.
  - unhealthyThreshold (pulumi.Input[float]) - The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
- portMapping (pulumi.Input[dict]) - The port mapping information for the listener.
  - port (pulumi.Input[float]) - The port used for the port mapping.
  - protocol (pulumi.Input[str]) - The protocol used for the port mapping. Valid values are http and tcp.
logging (pulumi.Input[dict]) - The inbound and outbound access logging information for the virtual node.
- accessLog (pulumi.Input[dict]) - The access log configuration for a virtual node.
  - file (pulumi.Input[dict]) - The file object to send virtual node access logs to.
    - path (pulumi.Input[str]) - The file path to write access logs to. You can use /dev/stdout to send access logs to standard out.
serviceDiscovery (pulumi.Input[dict]) - The service discovery information for the virtual node.
- awsCloudMap (pulumi.Input[dict]) - Specifies any AWS Cloud Map information for the virtual node.
  - attributes (pulumi.Input[dict]) - A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
  - namespaceName (pulumi.Input[str]) - The name of the AWS Cloud Map namespace to use. Use the servicediscovery.HttpNamespace resource to configure a Cloud Map namespace.
  - service_name (pulumi.Input[str]) - The name of the AWS Cloud Map service to use. Use the servicediscovery.Service resource to configure a Cloud Map service.
- dns (pulumi.Input[dict]) - Specifies the DNS service name for the virtual node.
  - hostname (pulumi.Input[str]) - The DNS host name for your virtual node.

arn: pulumi.Output[str] = None¶: The ARN of the virtual node.

created_date: pulumi.Output[str] = None¶: The creation date of the virtual node.

last_updated_date: pulumi.Output[str] = None¶: The last update date of the virtual node.

mesh_name: pulumi.Output[str] = None¶: The name of the service mesh in which to create the virtual node.

name: pulumi.Output[str] = None¶: The name to use for the virtual node.

spec: pulumi.Output[dict] = None¶

The virtual node specification to apply.

backends (list) - The backends to which the virtual node is expected to send outbound traffic.
- virtualService (dict) - Specifies a virtual service to use as a backend for a virtual node.
  - virtualServiceName (str) - The name of the virtual service that is acting as a virtual node backend.
listener (dict) - The listeners from which the virtual node is expected to receive inbound traffic.
- health_check (dict) - The health check information for the listener.
  - healthyThreshold (float) - The number of consecutive successful health checks that must occur before declaring listener healthy.
  - intervalMillis (float) - The time period in milliseconds between each health check execution.
  - path (str) - The destination path for the health check request. This is only required if the specified protocol is http.
  - port (float) - The destination port for the health check request. This port must match the port defined in the port_mapping for the listener.
  - protocol (str) - The protocol for the health check request. Valid values are http and tcp.
  - timeoutMillis (float) - The amount of time to wait when receiving a response from the health check, in milliseconds.
  - unhealthyThreshold (float) - The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
- portMapping (dict) - The port mapping information for the listener.
  - port (float) - The port used for the port mapping.
  - protocol (str) - The protocol used for the port mapping. Valid values are http and tcp.
logging (dict) - The inbound and outbound access logging information for the virtual node.
- accessLog (dict) - The access log configuration for a virtual node.
  - file (dict) - The file object to send virtual node access logs to.
    - path (str) - The file path to write access logs to. You can use /dev/stdout to send access logs to standard out.
serviceDiscovery (dict) - The service discovery information for the virtual node.
- awsCloudMap (dict) - Specifies any AWS Cloud Map information for the virtual node.
  - attributes (dict) - A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
  - namespaceName (str) - The name of the AWS Cloud Map namespace to use. Use the servicediscovery.HttpNamespace resource to configure a Cloud Map namespace.
  - service_name (str) - The name of the AWS Cloud Map service to use. Use the servicediscovery.Service resource to configure a Cloud Map service.
- dns (dict) - Specifies the DNS service name for the virtual node.
  - hostname (str) - The DNS host name for your virtual node.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, created_date=None, last_updated_date=None, mesh_name=None, name=None, spec=None, tags=None)¶

Get an existing VirtualNode resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the virtual node.
created_date (pulumi.Input[str]) – The creation date of the virtual node.
last_updated_date (pulumi.Input[str]) – The last update date of the virtual node.
mesh_name (pulumi.Input[str]) – The name of the service mesh in which to create the virtual node.
name (pulumi.Input[str]) – The name to use for the virtual node.
spec (pulumi.Input[dict]) – The virtual node specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The spec object supports the following:

backends (pulumi.Input[list]) - The backends to which the virtual node is expected to send outbound traffic.
- virtualService (pulumi.Input[dict]) - Specifies a virtual service to use as a backend for a virtual node.
  - virtualServiceName (pulumi.Input[str]) - The name of the virtual service that is acting as a virtual node backend.
listener (pulumi.Input[dict]) - The listeners from which the virtual node is expected to receive inbound traffic.
- health_check (pulumi.Input[dict]) - The health check information for the listener.
  - healthyThreshold (pulumi.Input[float]) - The number of consecutive successful health checks that must occur before declaring listener healthy.
  - intervalMillis (pulumi.Input[float]) - The time period in milliseconds between each health check execution.
  - path (pulumi.Input[str]) - The destination path for the health check request. This is only required if the specified protocol is http.
  - port (pulumi.Input[float]) - The destination port for the health check request. This port must match the port defined in the port_mapping for the listener.
  - protocol (pulumi.Input[str]) - The protocol for the health check request. Valid values are http and tcp.
  - timeoutMillis (pulumi.Input[float]) - The amount of time to wait when receiving a response from the health check, in milliseconds.
  - unhealthyThreshold (pulumi.Input[float]) - The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
- portMapping (pulumi.Input[dict]) - The port mapping information for the listener.
  - port (pulumi.Input[float]) - The port used for the port mapping.
  - protocol (pulumi.Input[str]) - The protocol used for the port mapping. Valid values are http and tcp.
logging (pulumi.Input[dict]) - The inbound and outbound access logging information for the virtual node.
- accessLog (pulumi.Input[dict]) - The access log configuration for a virtual node.
  - file (pulumi.Input[dict]) - The file object to send virtual node access logs to.
    - path (pulumi.Input[str]) - The file path to write access logs to. You can use /dev/stdout to send access logs to standard out.
serviceDiscovery (pulumi.Input[dict]) - The service discovery information for the virtual node.
- awsCloudMap (pulumi.Input[dict]) - Specifies any AWS Cloud Map information for the virtual node.
  - attributes (pulumi.Input[dict]) - A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
  - namespaceName (pulumi.Input[str]) - The name of the AWS Cloud Map namespace to use. Use the servicediscovery.HttpNamespace resource to configure a Cloud Map namespace.
  - service_name (pulumi.Input[str]) - The name of the AWS Cloud Map service to use. Use the servicediscovery.Service resource to configure a Cloud Map service.
- dns (pulumi.Input[dict]) - Specifies the DNS service name for the virtual node.
  - hostname (pulumi.Input[str]) - The DNS host name for your virtual node.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.appmesh.VirtualRouter(resource_name, opts=None, mesh_name=None, name=None, spec=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides an AWS App Mesh virtual router resource.

Because of backward incompatible API changes (read here and here), appmesh.VirtualRouter resource definitions created with provider versions earlier than v2.3.0 will need to be modified:

Remove service service_names from the spec argument. AWS has created a appmesh.VirtualService resource for each of service names. These resource can be imported using import.
Add a listener configuration block to the spec argument.

The state associated with existing resources will automatically be migrated.

import pulumi
import pulumi_aws as aws

serviceb = aws.appmesh.VirtualRouter("serviceb",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "listener": {
            "portMapping": {
                "port": 8080,
                "protocol": "http",
            },
        },
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
mesh_name (pulumi.Input[str]) – The name of the service mesh in which to create the virtual router.
name (pulumi.Input[str]) – The name to use for the virtual router.
spec (pulumi.Input[dict]) – The virtual router specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The spec object supports the following:

listener (pulumi.Input[dict]) - The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.
- portMapping (pulumi.Input[dict]) - The port mapping information for the listener.
  - port (pulumi.Input[float]) - The port used for the port mapping.
  - protocol (pulumi.Input[str]) - The protocol used for the port mapping. Valid values are http and tcp.

arn: pulumi.Output[str] = None¶: The ARN of the virtual router.

created_date: pulumi.Output[str] = None¶: The creation date of the virtual router.

last_updated_date: pulumi.Output[str] = None¶: The last update date of the virtual router.

mesh_name: pulumi.Output[str] = None¶: The name of the service mesh in which to create the virtual router.

name: pulumi.Output[str] = None¶: The name to use for the virtual router.

spec: pulumi.Output[dict] = None¶

The virtual router specification to apply.

listener (dict) - The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.
- portMapping (dict) - The port mapping information for the listener.
  - port (float) - The port used for the port mapping.
  - protocol (str) - The protocol used for the port mapping. Valid values are http and tcp.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, created_date=None, last_updated_date=None, mesh_name=None, name=None, spec=None, tags=None)¶

Get an existing VirtualRouter resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the virtual router.
created_date (pulumi.Input[str]) – The creation date of the virtual router.
last_updated_date (pulumi.Input[str]) – The last update date of the virtual router.
mesh_name (pulumi.Input[str]) – The name of the service mesh in which to create the virtual router.
name (pulumi.Input[str]) – The name to use for the virtual router.
spec (pulumi.Input[dict]) – The virtual router specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The spec object supports the following:

listener (pulumi.Input[dict]) - The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.
- portMapping (pulumi.Input[dict]) - The port mapping information for the listener.
  - port (pulumi.Input[float]) - The port used for the port mapping.
  - protocol (pulumi.Input[str]) - The protocol used for the port mapping. Valid values are http and tcp.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.appmesh.VirtualService(resource_name, opts=None, mesh_name=None, name=None, spec=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides an AWS App Mesh virtual service resource.

import pulumi
import pulumi_aws as aws

servicea = aws.appmesh.VirtualService("servicea",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "provider": {
            "virtualNode": {
                "virtualNodeName": aws_appmesh_virtual_node["serviceb1"]["name"],
            },
        },
    })

import pulumi
import pulumi_aws as aws

servicea = aws.appmesh.VirtualService("servicea",
    mesh_name=aws_appmesh_mesh["simple"]["id"],
    spec={
        "provider": {
            "virtualRouter": {
                "virtual_router_name": aws_appmesh_virtual_router["serviceb"]["name"],
            },
        },
    })

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
mesh_name (pulumi.Input[str]) – The name of the service mesh in which to create the virtual service.
name (pulumi.Input[str]) – The name to use for the virtual service.
spec (pulumi.Input[dict]) – The virtual service specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The spec object supports the following:

provider (pulumi.Input[dict]) - The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
- virtualNode (pulumi.Input[dict]) - The virtual node associated with a virtual service.
  - virtualNodeName (pulumi.Input[str]) - The name of the virtual node that is acting as a service provider.
- virtualRouter (pulumi.Input[dict]) - The virtual router associated with a virtual service.
  - virtual_router_name (pulumi.Input[str]) - The name of the virtual router that is acting as a service provider.

arn: pulumi.Output[str] = None¶: The ARN of the virtual service.

created_date: pulumi.Output[str] = None¶: The creation date of the virtual service.

last_updated_date: pulumi.Output[str] = None¶: The last update date of the virtual service.

mesh_name: pulumi.Output[str] = None¶: The name of the service mesh in which to create the virtual service.

name: pulumi.Output[str] = None¶: The name to use for the virtual service.

spec: pulumi.Output[dict] = None¶

The virtual service specification to apply.

provider (dict) - The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
- virtualNode (dict) - The virtual node associated with a virtual service.
  - virtualNodeName (str) - The name of the virtual node that is acting as a service provider.
- virtualRouter (dict) - The virtual router associated with a virtual service.
  - virtual_router_name (str) - The name of the virtual router that is acting as a service provider.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, created_date=None, last_updated_date=None, mesh_name=None, name=None, spec=None, tags=None)¶

Get an existing VirtualService resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the virtual service.
created_date (pulumi.Input[str]) – The creation date of the virtual service.
last_updated_date (pulumi.Input[str]) – The last update date of the virtual service.
mesh_name (pulumi.Input[str]) – The name of the service mesh in which to create the virtual service.
name (pulumi.Input[str]) – The name to use for the virtual service.
spec (pulumi.Input[dict]) – The virtual service specification to apply.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

The spec object supports the following:

provider (pulumi.Input[dict]) - The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
- virtualNode (pulumi.Input[dict]) - The virtual node associated with a virtual service.
  - virtualNodeName (pulumi.Input[str]) - The name of the virtual node that is acting as a service provider.
- virtualRouter (pulumi.Input[dict]) - The virtual router associated with a virtual service.
  - virtual_router_name (pulumi.Input[str]) - The name of the virtual router that is acting as a service provider.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

appmesh¶

On This Page