Constraint class
Manages a Service Catalog Constraint.
> NOTE: This resource does not associate a Service Catalog product and portfolio. However, the product and portfolio must be associated (see the aws.servicecatalog.ProductPortfolioAssociation resource) prior to creating a constraint or you will receive an error.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.servicecatalog.Constraint("example", {
description: "Back off, man. I'm a scientist.",
portfolioId: exampleAwsServicecatalogPortfolio.id,
productId: exampleAwsServicecatalogProduct.id,
type: "LAUNCH",
parameters: JSON.stringify({
RoleArn: "arn:aws:iam::123456789012:role/LaunchRole",
}),
});
import pulumi
import json
import pulumi_aws as aws
example = aws.servicecatalog.Constraint("example",
description="Back off, man. I'm a scientist.",
portfolio_id=example_aws_servicecatalog_portfolio["id"],
product_id=example_aws_servicecatalog_product["id"],
type="LAUNCH",
parameters=json.dumps({
"RoleArn": "arn:aws:iam::123456789012:role/LaunchRole",
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ServiceCatalog.Constraint("example", new()
{
Description = "Back off, man. I'm a scientist.",
PortfolioId = exampleAwsServicecatalogPortfolio.Id,
ProductId = exampleAwsServicecatalogProduct.Id,
Type = "LAUNCH",
Parameters = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["RoleArn"] = "arn:aws:iam::123456789012:role/LaunchRole",
}),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/servicecatalog"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]string{
"RoleArn": "arn:aws:iam::123456789012:role/LaunchRole",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = servicecatalog.NewConstraint(ctx, "example", &servicecatalog.ConstraintArgs{
Description: pulumi.String("Back off, man. I'm a scientist."),
PortfolioId: pulumi.Any(exampleAwsServicecatalogPortfolio.Id),
ProductId: pulumi.Any(exampleAwsServicecatalogProduct.Id),
Type: pulumi.String("LAUNCH"),
Parameters: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_servicecatalog_constraint" "example" {
description = "Back off, man. I'm a scientist."
portfolio_id = exampleAwsServicecatalogPortfolio.id
product_id = exampleAwsServicecatalogProduct.id
type = "LAUNCH"
parameters = jsonencode({
"RoleArn" = "arn:aws:iam::123456789012:role/LaunchRole"
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.servicecatalog.Constraint;
import com.pulumi.aws.servicecatalog.ConstraintArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 Constraint("example", ConstraintArgs.builder()
.description("Back off, man. I'm a scientist.")
.portfolioId(exampleAwsServicecatalogPortfolio.id())
.productId(exampleAwsServicecatalogProduct.id())
.type("LAUNCH")
.parameters(serializeJson(
jsonObject(
jsonProperty("RoleArn", "arn:aws:iam::123456789012:role/LaunchRole")
)))
.build());
}
}
resources:
example:
type: aws:servicecatalog:Constraint
properties:
description: Back off, man. I'm a scientist.
portfolioId: ${exampleAwsServicecatalogPortfolio.id}
productId: ${exampleAwsServicecatalogProduct.id}
type: LAUNCH
parameters:
fn::toJSON:
RoleArn: arn:aws:iam::123456789012:role/LaunchRole
Import
Using pulumi import, import aws.servicecatalog.Constraint using the constraint ID. For example:
$ pulumi import aws:servicecatalog/constraint:Constraint example cons-nmdkb6cgxfcrs
Constructors
- Constraint(String name, {ConstraintArgs? args, CustomResourceOptions? options})
-
Creates a new Constraint.
nameThe Pulumi resource name.argsArguments used to configure this Constraint. The set of arguments for Constraint.optionsResource options controlling this resource's behavior. - Constraint.reference(String urn)
- Creates a typed reference to an existing Constraint resource.
Properties
-
acceptLanguage
↔ Output<
String?> -
Language code. Valid values:
en(English),jp(Japanese),zh(Chinese). Default value isen.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String> -
Description of the constraint.
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
-
owner
↔ Output<
String> -
Owner of the constraint.
latefinal
-
parameters
↔ Output<
String> -
Constraint parameters in JSON format. The syntax depends on the constraint type. See details below.
latefinal
-
portfolioId
↔ Output<
String> -
Portfolio identifier.
latefinal
-
productId
↔ Output<
String> -
Product identifier.
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> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
Type of constraint. Valid values are
LAUNCH,NOTIFICATION,RESOURCE_UPDATE,STACKSET, andTEMPLATE.latefinal -
urn
↔ Output<
String> -
latefinalinherited
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, {ConstraintState? state, CustomResourceOptions? options}) → Constraint -
Gets an existing Constraint resource's state with the given
nameandid.