1. Packages
  2. AWS Classic
  3. API Docs
  4. transfer
  5. Profile

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

aws.transfer.Profile

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Provides a AWS Transfer AS2 Profile resource.

    Example Usage

    Basic

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      example:
        type: aws:transfer:Profile
        properties:
          as2Id: example
          certificateIds:
            - ${exampleAwsTransferCertificate.certificateId}
          usage: LOCAL
    

    Create Profile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Profile(name: string, args: ProfileArgs, opts?: CustomResourceOptions);
    @overload
    def Profile(resource_name: str,
                args: ProfileArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Profile(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                as2_id: Optional[str] = None,
                profile_type: Optional[str] = None,
                certificate_ids: Optional[Sequence[str]] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewProfile(ctx *Context, name string, args ProfileArgs, opts ...ResourceOption) (*Profile, error)
    public Profile(string name, ProfileArgs args, CustomResourceOptions? opts = null)
    public Profile(String name, ProfileArgs args)
    public Profile(String name, ProfileArgs args, CustomResourceOptions options)
    
    type: aws:transfer:Profile
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProfileArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProfileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleprofileResourceResourceFromTransferprofile = new Aws.Transfer.Profile("exampleprofileResourceResourceFromTransferprofile", new()
    {
        As2Id = "string",
        ProfileType = "string",
        CertificateIds = new[]
        {
            "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := transfer.NewProfile(ctx, "exampleprofileResourceResourceFromTransferprofile", &transfer.ProfileArgs{
    	As2Id:       pulumi.String("string"),
    	ProfileType: pulumi.String("string"),
    	CertificateIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var exampleprofileResourceResourceFromTransferprofile = new Profile("exampleprofileResourceResourceFromTransferprofile", ProfileArgs.builder()
        .as2Id("string")
        .profileType("string")
        .certificateIds("string")
        .tags(Map.of("string", "string"))
        .build());
    
    exampleprofile_resource_resource_from_transferprofile = aws.transfer.Profile("exampleprofileResourceResourceFromTransferprofile",
        as2_id="string",
        profile_type="string",
        certificate_ids=["string"],
        tags={
            "string": "string",
        })
    
    const exampleprofileResourceResourceFromTransferprofile = new aws.transfer.Profile("exampleprofileResourceResourceFromTransferprofile", {
        as2Id: "string",
        profileType: "string",
        certificateIds: ["string"],
        tags: {
            string: "string",
        },
    });
    
    type: aws:transfer:Profile
    properties:
        as2Id: string
        certificateIds:
            - string
        profileType: string
        tags:
            string: string
    

    Profile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Profile resource accepts the following input properties:

    As2Id string
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    ProfileType string
    The profile type should be LOCAL or PARTNER.
    CertificateIds List<string>
    The list of certificate Ids from the imported certificate operation.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    As2Id string
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    ProfileType string
    The profile type should be LOCAL or PARTNER.
    CertificateIds []string
    The list of certificate Ids from the imported certificate operation.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    as2Id String
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    profileType String
    The profile type should be LOCAL or PARTNER.
    certificateIds List<String>
    The list of certificate Ids from the imported certificate operation.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    as2Id string
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    profileType string
    The profile type should be LOCAL or PARTNER.
    certificateIds string[]
    The list of certificate Ids from the imported certificate operation.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    as2_id str
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    profile_type str
    The profile type should be LOCAL or PARTNER.
    certificate_ids Sequence[str]
    The list of certificate Ids from the imported certificate operation.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    as2Id String
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    profileType String
    The profile type should be LOCAL or PARTNER.
    certificateIds List<String>
    The list of certificate Ids from the imported certificate operation.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Profile resource produces the following output properties:

    Arn string
    The ARN of the profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProfileId string
    The unique identifier for the AS2 profile.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the profile.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProfileId string
    The unique identifier for the AS2 profile.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    The ARN of the profile.
    id String
    The provider-assigned unique ID for this managed resource.
    profileId String
    The unique identifier for the AS2 profile.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    The ARN of the profile.
    id string
    The provider-assigned unique ID for this managed resource.
    profileId string
    The unique identifier for the AS2 profile.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    The ARN of the profile.
    id str
    The provider-assigned unique ID for this managed resource.
    profile_id str
    The unique identifier for the AS2 profile.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    The ARN of the profile.
    id String
    The provider-assigned unique ID for this managed resource.
    profileId String
    The unique identifier for the AS2 profile.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing Profile Resource

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

    public static get(name: string, id: Input<ID>, state?: ProfileState, opts?: CustomResourceOptions): Profile
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            as2_id: Optional[str] = None,
            certificate_ids: Optional[Sequence[str]] = None,
            profile_id: Optional[str] = None,
            profile_type: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Profile
    func GetProfile(ctx *Context, name string, id IDInput, state *ProfileState, opts ...ResourceOption) (*Profile, error)
    public static Profile Get(string name, Input<string> id, ProfileState? state, CustomResourceOptions? opts = null)
    public static Profile get(String name, Output<String> id, ProfileState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the profile.
    As2Id string
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    CertificateIds List<string>
    The list of certificate Ids from the imported certificate operation.
    ProfileId string
    The unique identifier for the AS2 profile.
    ProfileType string
    The profile type should be LOCAL or PARTNER.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the profile.
    As2Id string
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    CertificateIds []string
    The list of certificate Ids from the imported certificate operation.
    ProfileId string
    The unique identifier for the AS2 profile.
    ProfileType string
    The profile type should be LOCAL or PARTNER.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    The ARN of the profile.
    as2Id String
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    certificateIds List<String>
    The list of certificate Ids from the imported certificate operation.
    profileId String
    The unique identifier for the AS2 profile.
    profileType String
    The profile type should be LOCAL or PARTNER.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    The ARN of the profile.
    as2Id string
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    certificateIds string[]
    The list of certificate Ids from the imported certificate operation.
    profileId string
    The unique identifier for the AS2 profile.
    profileType string
    The profile type should be LOCAL or PARTNER.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    The ARN of the profile.
    as2_id str
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    certificate_ids Sequence[str]
    The list of certificate Ids from the imported certificate operation.
    profile_id str
    The unique identifier for the AS2 profile.
    profile_type str
    The profile type should be LOCAL or PARTNER.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    The ARN of the profile.
    as2Id String
    The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers 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. his ID cannot include spaces.
    certificateIds List<String>
    The list of certificate Ids from the imported certificate operation.
    profileId String
    The unique identifier for the AS2 profile.
    profileType String
    The profile type should be LOCAL or PARTNER.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import Transfer AS2 Profile using the profile_id. For example:

    $ pulumi import aws:transfer/profile:Profile example p-4221a88afd5f4362a
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi