1. Packages
  2. AWS
  3. API Docs
  4. appfabric
  5. Ingestion
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.appfabric.Ingestion

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Resource for managing an AWS AppFabric Ingestion.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.appfabric.Ingestion("example", {
        app: "OKTA",
        appBundleArn: exampleAwsAppfabricAppBundle.arn,
        tenantId: "example.okta.com",
        ingestionType: "auditLog",
        tags: {
            Environment: "test",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.appfabric.Ingestion("example",
        app="OKTA",
        app_bundle_arn=example_aws_appfabric_app_bundle["arn"],
        tenant_id="example.okta.com",
        ingestion_type="auditLog",
        tags={
            "Environment": "test",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appfabric"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := appfabric.NewIngestion(ctx, "example", &appfabric.IngestionArgs{
    			App:           pulumi.String("OKTA"),
    			AppBundleArn:  pulumi.Any(exampleAwsAppfabricAppBundle.Arn),
    			TenantId:      pulumi.String("example.okta.com"),
    			IngestionType: pulumi.String("auditLog"),
    			Tags: pulumi.StringMap{
    				"Environment": pulumi.String("test"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.AppFabric.Ingestion("example", new()
        {
            App = "OKTA",
            AppBundleArn = exampleAwsAppfabricAppBundle.Arn,
            TenantId = "example.okta.com",
            IngestionType = "auditLog",
            Tags = 
            {
                { "Environment", "test" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appfabric.Ingestion;
    import com.pulumi.aws.appfabric.IngestionArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 Ingestion("example", IngestionArgs.builder()
                .app("OKTA")
                .appBundleArn(exampleAwsAppfabricAppBundle.arn())
                .tenantId("example.okta.com")
                .ingestionType("auditLog")
                .tags(Map.of("Environment", "test"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:appfabric:Ingestion
        properties:
          app: OKTA
          appBundleArn: ${exampleAwsAppfabricAppBundle.arn}
          tenantId: example.okta.com
          ingestionType: auditLog
          tags:
            Environment: test
    

    Create Ingestion Resource

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

    Constructor syntax

    new Ingestion(name: string, args: IngestionArgs, opts?: CustomResourceOptions);
    @overload
    def Ingestion(resource_name: str,
                  args: IngestionArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Ingestion(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  app: Optional[str] = None,
                  app_bundle_arn: Optional[str] = None,
                  ingestion_type: Optional[str] = None,
                  tenant_id: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
    func NewIngestion(ctx *Context, name string, args IngestionArgs, opts ...ResourceOption) (*Ingestion, error)
    public Ingestion(string name, IngestionArgs args, CustomResourceOptions? opts = null)
    public Ingestion(String name, IngestionArgs args)
    public Ingestion(String name, IngestionArgs args, CustomResourceOptions options)
    
    type: aws:appfabric:Ingestion
    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 IngestionArgs
    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 IngestionArgs
    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 IngestionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IngestionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IngestionArgs
    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 ingestionResource = new Aws.AppFabric.Ingestion("ingestionResource", new()
    {
        App = "string",
        AppBundleArn = "string",
        IngestionType = "string",
        TenantId = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := appfabric.NewIngestion(ctx, "ingestionResource", &appfabric.IngestionArgs{
    	App:           pulumi.String("string"),
    	AppBundleArn:  pulumi.String("string"),
    	IngestionType: pulumi.String("string"),
    	TenantId:      pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var ingestionResource = new Ingestion("ingestionResource", IngestionArgs.builder()
        .app("string")
        .appBundleArn("string")
        .ingestionType("string")
        .tenantId("string")
        .tags(Map.of("string", "string"))
        .build());
    
    ingestion_resource = aws.appfabric.Ingestion("ingestionResource",
        app="string",
        app_bundle_arn="string",
        ingestion_type="string",
        tenant_id="string",
        tags={
            "string": "string",
        })
    
    const ingestionResource = new aws.appfabric.Ingestion("ingestionResource", {
        app: "string",
        appBundleArn: "string",
        ingestionType: "string",
        tenantId: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:appfabric:Ingestion
    properties:
        app: string
        appBundleArn: string
        ingestionType: string
        tags:
            string: string
        tenantId: string
    

    Ingestion 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 Ingestion resource accepts the following input properties:

    App string
    Name of the application. Refer to the AWS Documentation for the list of valid values
    AppBundleArn string
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    IngestionType string
    Ingestion type. Valid values are auditLog.
    TenantId string
    ID of the application tenant.
    Tags Dictionary<string, string>
    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.
    App string
    Name of the application. Refer to the AWS Documentation for the list of valid values
    AppBundleArn string
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    IngestionType string
    Ingestion type. Valid values are auditLog.
    TenantId string
    ID of the application tenant.
    Tags map[string]string
    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.
    app String
    Name of the application. Refer to the AWS Documentation for the list of valid values
    appBundleArn String
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    ingestionType String
    Ingestion type. Valid values are auditLog.
    tenantId String
    ID of the application tenant.
    tags Map<String,String>
    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.
    app string
    Name of the application. Refer to the AWS Documentation for the list of valid values
    appBundleArn string
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    ingestionType string
    Ingestion type. Valid values are auditLog.
    tenantId string
    ID of the application tenant.
    tags {[key: string]: string}
    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.
    app str
    Name of the application. Refer to the AWS Documentation for the list of valid values
    app_bundle_arn str
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    ingestion_type str
    Ingestion type. Valid values are auditLog.
    tenant_id str
    ID of the application tenant.
    tags Mapping[str, str]
    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.
    app String
    Name of the application. Refer to the AWS Documentation for the list of valid values
    appBundleArn String
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    ingestionType String
    Ingestion type. Valid values are auditLog.
    tenantId String
    ID of the application tenant.
    tags Map<String>
    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 Ingestion resource produces the following output properties:

    Arn string
    ARN of the Ingestion.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Ingestion.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Ingestion.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Ingestion.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Ingestion.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Ingestion.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Ingestion Resource

    Get an existing Ingestion 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?: IngestionState, opts?: CustomResourceOptions): Ingestion
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            app: Optional[str] = None,
            app_bundle_arn: Optional[str] = None,
            arn: Optional[str] = None,
            ingestion_type: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            tenant_id: Optional[str] = None) -> Ingestion
    func GetIngestion(ctx *Context, name string, id IDInput, state *IngestionState, opts ...ResourceOption) (*Ingestion, error)
    public static Ingestion Get(string name, Input<string> id, IngestionState? state, CustomResourceOptions? opts = null)
    public static Ingestion get(String name, Output<String> id, IngestionState 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:
    App string
    Name of the application. Refer to the AWS Documentation for the list of valid values
    AppBundleArn string
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    Arn string
    ARN of the Ingestion.
    IngestionType string
    Ingestion type. Valid values are auditLog.
    Tags Dictionary<string, string>
    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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TenantId string
    ID of the application tenant.
    App string
    Name of the application. Refer to the AWS Documentation for the list of valid values
    AppBundleArn string
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    Arn string
    ARN of the Ingestion.
    IngestionType string
    Ingestion type. Valid values are auditLog.
    Tags map[string]string
    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
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TenantId string
    ID of the application tenant.
    app String
    Name of the application. Refer to the AWS Documentation for the list of valid values
    appBundleArn String
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    arn String
    ARN of the Ingestion.
    ingestionType String
    Ingestion type. Valid values are auditLog.
    tags Map<String,String>
    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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    tenantId String
    ID of the application tenant.
    app string
    Name of the application. Refer to the AWS Documentation for the list of valid values
    appBundleArn string
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    arn string
    ARN of the Ingestion.
    ingestionType string
    Ingestion type. Valid values are auditLog.
    tags {[key: string]: string}
    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}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    tenantId string
    ID of the application tenant.
    app str
    Name of the application. Refer to the AWS Documentation for the list of valid values
    app_bundle_arn str
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    arn str
    ARN of the Ingestion.
    ingestion_type str
    Ingestion type. Valid values are auditLog.
    tags Mapping[str, str]
    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]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    tenant_id str
    ID of the application tenant.
    app String
    Name of the application. Refer to the AWS Documentation for the list of valid values
    appBundleArn String
    Amazon Resource Name (ARN) of the app bundle to use for the request.
    arn String
    ARN of the Ingestion.
    ingestionType String
    Ingestion type. Valid values are auditLog.
    tags Map<String>
    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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    tenantId String
    ID of the application tenant.

    Import

    Using pulumi import, import AppFabric Ingestion using the app_bundle_identifier and arn separated by ,. For example:

    $ pulumi import aws:appfabric/ingestion:Ingestion example arn:aws:appfabric:[region]:[account]:appbundle/a9b91477-8831-43c0-970c-xxxxxxxxxx,arn:aws:appfabric:[region]:[account]:appbundle/a9b91477-8831-43c0-970c-xxxxxxxxxx/ingestion/32251416-710b-4425-96ca-xxxxxxxxxx
    

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi