Profile class
Provides a AWS Transfer AS2 Profile resource.
Example Usage
Basic
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.transfer.Profile("example", {
as2Id: "example",
certificateIds: [exampleAwsTransferCertificate.certificateId],
usage: "LOCAL",
});
import pulumi
import pulumi_aws as aws
example = aws.transfer.Profile("example",
as2_id="example",
certificate_ids=[example_aws_transfer_certificate["certificateId"]],
usage="LOCAL")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Transfer.Profile("example", new()
{
As2Id = "example",
CertificateIds = new[]
{
exampleAwsTransferCertificate.CertificateId,
},
Usage = "LOCAL",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/transfer"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := transfer.NewProfile(ctx, "example", &transfer.ProfileArgs{
As2Id: pulumi.String("example"),
CertificateIds: pulumi.StringArray{
exampleAwsTransferCertificate.CertificateId,
},
Usage: "LOCAL",
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_transfer_profile" "example" {
as2_id = "example"
certificate_ids = [exampleAwsTransferCertificate.certificateId]
usage = "LOCAL"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.transfer.Profile;
import com.pulumi.aws.transfer.ProfileArgs;
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 Profile("example", ProfileArgs.builder()
.as2Id("example")
.certificateIds(exampleAwsTransferCertificate.certificateId())
.usage("LOCAL")
.build());
}
}
resources:
example:
type: aws:transfer:Profile
properties:
as2Id: example
certificateIds:
- ${exampleAwsTransferCertificate.certificateId}
usage: LOCAL
Import
Using pulumi import, import Transfer AS2 Profile using the profileId. For example:
$ pulumi import aws:transfer/profile:Profile example p-4221a88afd5f4362a
Constructors
- Profile(String name, {ProfileArgs? args, CustomResourceOptions? options})
-
Creates a new Profile.
nameThe Pulumi resource name.argsArguments used to configure this Profile. The set of arguments for Profile.optionsResource options controlling this resource's behavior. - Profile.reference(String urn)
- Creates a typed reference to an existing Profile resource.
Properties
-
arn
↔ Output<
String> -
ARN of the profile.
latefinal
-
as2Id
↔ Output<
String> -
AS2 name as defined in RFC 4130. For inbound transfers this is the AS2 From Header for the AS2 messages sent from the partner. For outbound messages this is the AS2 To Header for the AS2 messages sent to the partner. This ID cannot include spaces.
latefinal
-
certificateIds
↔ Output<
List< String> ?> -
List of certificate IDs from the imported certificate operation.
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
-
profileId
↔ Output<
String> -
Unique identifier for the AS2 profile.
latefinal
-
profileType
↔ Output<
String> -
Profile type. Valid values are
LOCALorPARTNER.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
-
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
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