DeploymentType class
Manages an API Gateway REST Deployment. A deployment is a snapshot of the REST API configuration. The deployment can then be published to callable endpoints via the aws.apigateway.Stage resource and optionally managed further with the aws.apigateway.BasePathMapping resource, aws.apigateway.DomainName resource, and aws.apigateway.MethodSettings resource. For more information, see the API Gateway Developer Guide.
To properly capture all REST API configuration in a deployment, this resource must have dependencies on all prior resources that manage resources/paths, methods, integrations, etc.
- For REST APIs that are configured via OpenAPI specification (
aws.apigateway.RestApiresourcebodyargument), no special dependency setup is needed beyond referencing theidattribute of that resource unless additional resources have further customized the REST API. - When the REST API configuration involves other resources (
aws.apigateway.Integrationresource), the dependency setup can be done with implicit resource references in thetriggersargument or explicit resource references using the resourcedependsOncustom option. Thetriggersargument should be preferred overdependsOn, sincedependsOncan only capture dependency ordering and will not cause the resource to recreate (redeploy the REST API) with upstream configuration changes.
Example Usage
Import
Using pulumi import, import aws.apigateway.Deployment using REST-API-ID/DEPLOYMENT-ID. For example:
$ pulumi import aws:apigateway/deployment:Deployment example aabbccddee/1122334
The variables arguments cannot be imported. Use the aws.apigateway.Stage resource to import and manage stages.
The triggers argument cannot be imported.
Constructors
- DeploymentType(String name, {DeploymentArgs? args, CustomResourceOptions? options})
-
Creates a new DeploymentType.
nameThe Pulumi resource name.argsArguments used to configure this DeploymentType. The set of arguments for Deployment.optionsResource options controlling this resource's behavior. - DeploymentType.reference(String urn)
- Creates a typed reference to an existing DeploymentType resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdDate
↔ Output<
String> -
Creation date of the deployment
latefinal
-
description
↔ Output<
String?> -
Description of the deployment.
latefinal
- 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
-
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
-
restApi
↔ Output<
String> -
REST API identifier.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
triggers
↔ Output<
Map< String, String> ?> -
Map of arbitrary keys and values that, when changed, will trigger a redeployment.
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
-
variables
↔ Output<
Map< String, String> ?> -
Map to set on the related stage.
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
Static Methods
-
get(
String name, Input< String> id, {DeploymentState? state, CustomResourceOptions? options}) → DeploymentType -
Gets an existing DeploymentType resource's state with the given
nameandid.