1. Packages
  2. SignalFx
  3. API Docs
  4. aws
  5. TokenIntegration
SignalFx v7.1.3 published on Wednesday, Apr 24, 2024 by Pulumi

signalfx.aws.TokenIntegration

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.3 published on Wednesday, Apr 24, 2024 by Pulumi

    Splunk Observability AWS CloudWatch integrations using security tokens. For help with this integration see Connect to AWS CloudWatch.

    NOTE When managing integrations, use a session token of an administrator to authenticate the Splunk Observabilit Cloud provider. See Operations that require a session token for an administrator.

    WARNING This resource implements a part of a workflow. You must use it with signalfx.aws.Integration.

    Example

    resource "signalfx_aws_token_integration" "aws_myteam_token" {
      name = "My AWS integration"
    }
    
    // Make yourself an AWS IAM role here
    resource "aws_iam_role" "aws_sfx_role" {
      // Stuff here that uses the external and account ID
    }
    
    resource "signalfx_aws_integration" "aws_myteam" {
      enabled = true
    
      integration_id     = signalfx_aws_token_integration.aws_myteam_token.id
      token              = "put_your_token_here"
      key                = "put_your_key_here"
      regions            = ["us-east-1"]
      poll_rate          = 300
      import_cloud_watch = true
      enable_aws_usage   = true
    
      custom_namespace_sync_rule {
        default_action = "Exclude"
        filter_action  = "Include"
        filter_source  = "filter('code', '200')"
        namespace      = "my-custom-namespace"
      }
    
      namespace_sync_rule {
        default_action = "Exclude"
        filter_action  = "Include"
        filter_source  = "filter('code', '200')"
        namespace      = "AWS/EC2"
      }
    }
    

    Arguments

    • name - (Required) The name of this integration

    Attributes

    In addition to all arguments above, the following attributes are exported:

    • id - The ID of the integration to use with signalfx.aws.Integration
    • signalfx_aws_account - The AWS Account ARN to use with your policies/roles, provided by Splunk Observability Cloud.

    Create TokenIntegration Resource

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

    Constructor syntax

    new TokenIntegration(name: string, args?: TokenIntegrationArgs, opts?: CustomResourceOptions);
    @overload
    def TokenIntegration(resource_name: str,
                         args: Optional[TokenIntegrationArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def TokenIntegration(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         name: Optional[str] = None)
    func NewTokenIntegration(ctx *Context, name string, args *TokenIntegrationArgs, opts ...ResourceOption) (*TokenIntegration, error)
    public TokenIntegration(string name, TokenIntegrationArgs? args = null, CustomResourceOptions? opts = null)
    public TokenIntegration(String name, TokenIntegrationArgs args)
    public TokenIntegration(String name, TokenIntegrationArgs args, CustomResourceOptions options)
    
    type: signalfx:aws:TokenIntegration
    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 TokenIntegrationArgs
    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 TokenIntegrationArgs
    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 TokenIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TokenIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TokenIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var tokenIntegrationResource = new SignalFx.Aws.TokenIntegration("tokenIntegrationResource", new()
    {
        Name = "string",
    });
    
    example, err := aws.NewTokenIntegration(ctx, "tokenIntegrationResource", &aws.TokenIntegrationArgs{
    	Name: pulumi.String("string"),
    })
    
    var tokenIntegrationResource = new TokenIntegration("tokenIntegrationResource", TokenIntegrationArgs.builder()        
        .name("string")
        .build());
    
    token_integration_resource = signalfx.aws.TokenIntegration("tokenIntegrationResource", name="string")
    
    const tokenIntegrationResource = new signalfx.aws.TokenIntegration("tokenIntegrationResource", {name: "string"});
    
    type: signalfx:aws:TokenIntegration
    properties:
        name: string
    

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

    Name string
    Name of the integration
    Name string
    Name of the integration
    name String
    Name of the integration
    name string
    Name of the integration
    name str
    Name of the integration
    name String
    Name of the integration

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SignalfxAwsAccount string
    The Splunk Observability AWS account ID to use with an AWS role.
    TokenId string
    The SignalFx-generated AWS token to use with an AWS integration.
    Id string
    The provider-assigned unique ID for this managed resource.
    SignalfxAwsAccount string
    The Splunk Observability AWS account ID to use with an AWS role.
    TokenId string
    The SignalFx-generated AWS token to use with an AWS integration.
    id String
    The provider-assigned unique ID for this managed resource.
    signalfxAwsAccount String
    The Splunk Observability AWS account ID to use with an AWS role.
    tokenId String
    The SignalFx-generated AWS token to use with an AWS integration.
    id string
    The provider-assigned unique ID for this managed resource.
    signalfxAwsAccount string
    The Splunk Observability AWS account ID to use with an AWS role.
    tokenId string
    The SignalFx-generated AWS token to use with an AWS integration.
    id str
    The provider-assigned unique ID for this managed resource.
    signalfx_aws_account str
    The Splunk Observability AWS account ID to use with an AWS role.
    token_id str
    The SignalFx-generated AWS token to use with an AWS integration.
    id String
    The provider-assigned unique ID for this managed resource.
    signalfxAwsAccount String
    The Splunk Observability AWS account ID to use with an AWS role.
    tokenId String
    The SignalFx-generated AWS token to use with an AWS integration.

    Look up Existing TokenIntegration Resource

    Get an existing TokenIntegration 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?: TokenIntegrationState, opts?: CustomResourceOptions): TokenIntegration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            signalfx_aws_account: Optional[str] = None,
            token_id: Optional[str] = None) -> TokenIntegration
    func GetTokenIntegration(ctx *Context, name string, id IDInput, state *TokenIntegrationState, opts ...ResourceOption) (*TokenIntegration, error)
    public static TokenIntegration Get(string name, Input<string> id, TokenIntegrationState? state, CustomResourceOptions? opts = null)
    public static TokenIntegration get(String name, Output<String> id, TokenIntegrationState 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:
    Name string
    Name of the integration
    SignalfxAwsAccount string
    The Splunk Observability AWS account ID to use with an AWS role.
    TokenId string
    The SignalFx-generated AWS token to use with an AWS integration.
    Name string
    Name of the integration
    SignalfxAwsAccount string
    The Splunk Observability AWS account ID to use with an AWS role.
    TokenId string
    The SignalFx-generated AWS token to use with an AWS integration.
    name String
    Name of the integration
    signalfxAwsAccount String
    The Splunk Observability AWS account ID to use with an AWS role.
    tokenId String
    The SignalFx-generated AWS token to use with an AWS integration.
    name string
    Name of the integration
    signalfxAwsAccount string
    The Splunk Observability AWS account ID to use with an AWS role.
    tokenId string
    The SignalFx-generated AWS token to use with an AWS integration.
    name str
    Name of the integration
    signalfx_aws_account str
    The Splunk Observability AWS account ID to use with an AWS role.
    token_id str
    The SignalFx-generated AWS token to use with an AWS integration.
    name String
    Name of the integration
    signalfxAwsAccount String
    The Splunk Observability AWS account ID to use with an AWS role.
    tokenId String
    The SignalFx-generated AWS token to use with an AWS integration.

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.1.3 published on Wednesday, Apr 24, 2024 by Pulumi