We recommend new projects start with resources from the AWS provider.
aws-native.transfer.Agreement
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Transfer::Agreement
Create Agreement Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Agreement(name: string, args: AgreementArgs, opts?: CustomResourceOptions);@overload
def Agreement(resource_name: str,
              args: AgreementArgs,
              opts: Optional[ResourceOptions] = None)
@overload
def Agreement(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              access_role: Optional[str] = None,
              local_profile_id: Optional[str] = None,
              partner_profile_id: Optional[str] = None,
              server_id: Optional[str] = None,
              base_directory: Optional[str] = None,
              custom_directories: Optional[CustomDirectoriesPropertiesArgs] = None,
              description: Optional[str] = None,
              enforce_message_signing: Optional[AgreementEnforceMessageSigning] = None,
              preserve_filename: Optional[AgreementPreserveFilename] = None,
              status: Optional[AgreementStatus] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewAgreement(ctx *Context, name string, args AgreementArgs, opts ...ResourceOption) (*Agreement, error)public Agreement(string name, AgreementArgs args, CustomResourceOptions? opts = null)
public Agreement(String name, AgreementArgs args)
public Agreement(String name, AgreementArgs args, CustomResourceOptions options)
type: aws-native:transfer:Agreement
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 AgreementArgs
- 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 AgreementArgs
- 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 AgreementArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgreementArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgreementArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Agreement Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Agreement resource accepts the following input properties:
- AccessRole string
- Specifies the access role for the agreement.
- LocalProfile stringId 
- A unique identifier for the local profile.
- PartnerProfile stringId 
- A unique identifier for the partner profile.
- ServerId string
- A unique identifier for the server.
- BaseDirectory string
- Specifies the base directory for the agreement.
- CustomDirectories Pulumi.Aws Native. Transfer. Inputs. Custom Directories Properties 
- Specifies a separate directory for each type of file to store for an AS2 message.
- Description string
- A textual description for the agreement.
- EnforceMessage Pulumi.Signing Aws Native. Transfer. Agreement Enforce Message Signing 
- Specifies whether to enforce an AS2 message is signed for this agreement.
- PreserveFilename Pulumi.Aws Native. Transfer. Agreement Preserve Filename 
- Specifies whether to preserve the filename received for this agreement.
- Status
Pulumi.Aws Native. Transfer. Agreement Status 
- Specifies the status of the agreement.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
- AccessRole string
- Specifies the access role for the agreement.
- LocalProfile stringId 
- A unique identifier for the local profile.
- PartnerProfile stringId 
- A unique identifier for the partner profile.
- ServerId string
- A unique identifier for the server.
- BaseDirectory string
- Specifies the base directory for the agreement.
- CustomDirectories CustomDirectories Properties Args 
- Specifies a separate directory for each type of file to store for an AS2 message.
- Description string
- A textual description for the agreement.
- EnforceMessage AgreementSigning Enforce Message Signing 
- Specifies whether to enforce an AS2 message is signed for this agreement.
- PreserveFilename AgreementPreserve Filename 
- Specifies whether to preserve the filename received for this agreement.
- Status
AgreementStatus 
- Specifies the status of the agreement.
- 
TagArgs 
- Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
- accessRole String
- Specifies the access role for the agreement.
- localProfile StringId 
- A unique identifier for the local profile.
- partnerProfile StringId 
- A unique identifier for the partner profile.
- serverId String
- A unique identifier for the server.
- baseDirectory String
- Specifies the base directory for the agreement.
- customDirectories CustomDirectories Properties 
- Specifies a separate directory for each type of file to store for an AS2 message.
- description String
- A textual description for the agreement.
- enforceMessage AgreementSigning Enforce Message Signing 
- Specifies whether to enforce an AS2 message is signed for this agreement.
- preserveFilename AgreementPreserve Filename 
- Specifies whether to preserve the filename received for this agreement.
- status
AgreementStatus 
- Specifies the status of the agreement.
- List<Tag>
- Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
- accessRole string
- Specifies the access role for the agreement.
- localProfile stringId 
- A unique identifier for the local profile.
- partnerProfile stringId 
- A unique identifier for the partner profile.
- serverId string
- A unique identifier for the server.
- baseDirectory string
- Specifies the base directory for the agreement.
- customDirectories CustomDirectories Properties 
- Specifies a separate directory for each type of file to store for an AS2 message.
- description string
- A textual description for the agreement.
- enforceMessage AgreementSigning Enforce Message Signing 
- Specifies whether to enforce an AS2 message is signed for this agreement.
- preserveFilename AgreementPreserve Filename 
- Specifies whether to preserve the filename received for this agreement.
- status
AgreementStatus 
- Specifies the status of the agreement.
- Tag[]
- Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
- access_role str
- Specifies the access role for the agreement.
- local_profile_ strid 
- A unique identifier for the local profile.
- partner_profile_ strid 
- A unique identifier for the partner profile.
- server_id str
- A unique identifier for the server.
- base_directory str
- Specifies the base directory for the agreement.
- custom_directories CustomDirectories Properties Args 
- Specifies a separate directory for each type of file to store for an AS2 message.
- description str
- A textual description for the agreement.
- enforce_message_ Agreementsigning Enforce Message Signing 
- Specifies whether to enforce an AS2 message is signed for this agreement.
- preserve_filename AgreementPreserve Filename 
- Specifies whether to preserve the filename received for this agreement.
- status
AgreementStatus 
- Specifies the status of the agreement.
- 
Sequence[TagArgs] 
- Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
- accessRole String
- Specifies the access role for the agreement.
- localProfile StringId 
- A unique identifier for the local profile.
- partnerProfile StringId 
- A unique identifier for the partner profile.
- serverId String
- A unique identifier for the server.
- baseDirectory String
- Specifies the base directory for the agreement.
- customDirectories Property Map
- Specifies a separate directory for each type of file to store for an AS2 message.
- description String
- A textual description for the agreement.
- enforceMessage "ENABLED" | "DISABLED"Signing 
- Specifies whether to enforce an AS2 message is signed for this agreement.
- preserveFilename "ENABLED" | "DISABLED"
- Specifies whether to preserve the filename received for this agreement.
- status "ACTIVE" | "INACTIVE"
- Specifies the status of the agreement.
- List<Property Map>
- Key-value pairs that can be used to group and search for agreements. Tags are metadata attached to agreements for any purpose.
Outputs
All input properties are implicitly available as output properties. Additionally, the Agreement resource produces the following output properties:
- AgreementId string
- A unique identifier for the agreement.
- Arn string
- Specifies the unique Amazon Resource Name (ARN) for the agreement.
- Id string
- The provider-assigned unique ID for this managed resource.
- AgreementId string
- A unique identifier for the agreement.
- Arn string
- Specifies the unique Amazon Resource Name (ARN) for the agreement.
- Id string
- The provider-assigned unique ID for this managed resource.
- agreementId String
- A unique identifier for the agreement.
- arn String
- Specifies the unique Amazon Resource Name (ARN) for the agreement.
- id String
- The provider-assigned unique ID for this managed resource.
- agreementId string
- A unique identifier for the agreement.
- arn string
- Specifies the unique Amazon Resource Name (ARN) for the agreement.
- id string
- The provider-assigned unique ID for this managed resource.
- agreement_id str
- A unique identifier for the agreement.
- arn str
- Specifies the unique Amazon Resource Name (ARN) for the agreement.
- id str
- The provider-assigned unique ID for this managed resource.
- agreementId String
- A unique identifier for the agreement.
- arn String
- Specifies the unique Amazon Resource Name (ARN) for the agreement.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
AgreementEnforceMessageSigning, AgreementEnforceMessageSigningArgs        
- Enabled
- ENABLED
- Disabled
- DISABLED
- AgreementEnforce Message Signing Enabled 
- ENABLED
- AgreementEnforce Message Signing Disabled 
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
AgreementPreserveFilename, AgreementPreserveFilenameArgs      
- Enabled
- ENABLED
- Disabled
- DISABLED
- AgreementPreserve Filename Enabled 
- ENABLED
- AgreementPreserve Filename Disabled 
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
AgreementStatus, AgreementStatusArgs    
- Active
- ACTIVE
- Inactive
- INACTIVE
- AgreementStatus Active 
- ACTIVE
- AgreementStatus Inactive 
- INACTIVE
- Active
- ACTIVE
- Inactive
- INACTIVE
- Active
- ACTIVE
- Inactive
- INACTIVE
- ACTIVE
- ACTIVE
- INACTIVE
- INACTIVE
- "ACTIVE"
- ACTIVE
- "INACTIVE"
- INACTIVE
CustomDirectoriesProperties, CustomDirectoriesPropertiesArgs      
- FailedFiles stringDirectory 
- Specifies a location to store the failed files for an AS2 message.
- MdnFiles stringDirectory 
- Specifies a location to store the MDN file for an AS2 message.
- PayloadFiles stringDirectory 
- Specifies a location to store the payload file for an AS2 message.
- StatusFiles stringDirectory 
- Specifies a location to store the status file for an AS2 message.
- TemporaryFiles stringDirectory 
- Specifies a location to store the temporary processing file for an AS2 message.
- FailedFiles stringDirectory 
- Specifies a location to store the failed files for an AS2 message.
- MdnFiles stringDirectory 
- Specifies a location to store the MDN file for an AS2 message.
- PayloadFiles stringDirectory 
- Specifies a location to store the payload file for an AS2 message.
- StatusFiles stringDirectory 
- Specifies a location to store the status file for an AS2 message.
- TemporaryFiles stringDirectory 
- Specifies a location to store the temporary processing file for an AS2 message.
- failedFiles StringDirectory 
- Specifies a location to store the failed files for an AS2 message.
- mdnFiles StringDirectory 
- Specifies a location to store the MDN file for an AS2 message.
- payloadFiles StringDirectory 
- Specifies a location to store the payload file for an AS2 message.
- statusFiles StringDirectory 
- Specifies a location to store the status file for an AS2 message.
- temporaryFiles StringDirectory 
- Specifies a location to store the temporary processing file for an AS2 message.
- failedFiles stringDirectory 
- Specifies a location to store the failed files for an AS2 message.
- mdnFiles stringDirectory 
- Specifies a location to store the MDN file for an AS2 message.
- payloadFiles stringDirectory 
- Specifies a location to store the payload file for an AS2 message.
- statusFiles stringDirectory 
- Specifies a location to store the status file for an AS2 message.
- temporaryFiles stringDirectory 
- Specifies a location to store the temporary processing file for an AS2 message.
- failed_files_ strdirectory 
- Specifies a location to store the failed files for an AS2 message.
- mdn_files_ strdirectory 
- Specifies a location to store the MDN file for an AS2 message.
- payload_files_ strdirectory 
- Specifies a location to store the payload file for an AS2 message.
- status_files_ strdirectory 
- Specifies a location to store the status file for an AS2 message.
- temporary_files_ strdirectory 
- Specifies a location to store the temporary processing file for an AS2 message.
- failedFiles StringDirectory 
- Specifies a location to store the failed files for an AS2 message.
- mdnFiles StringDirectory 
- Specifies a location to store the MDN file for an AS2 message.
- payloadFiles StringDirectory 
- Specifies a location to store the payload file for an AS2 message.
- statusFiles StringDirectory 
- Specifies a location to store the status file for an AS2 message.
- temporaryFiles StringDirectory 
- Specifies a location to store the temporary processing file for an AS2 message.
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.