Package software.amazon.awssdk.services.oam.model

Class CreateLinkRequest

    • Method Detail

      • labelTemplate

        public final String labelTemplate()

        Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

        You can use a custom label or use the following variables:

        • $AccountName is the name of the account

        • $AccountEmail is the globally unique email address of the account

        • $AccountEmailNoDomain is the email address of the account without the domain name

        Returns:
        Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

        You can use a custom label or use the following variables:

        • $AccountName is the name of the account

        • $AccountEmail is the globally unique email address of the account

        • $AccountEmailNoDomain is the email address of the account without the domain name

      • resourceTypes

        public final List<ResourceType> resourceTypes()

        An array of strings that define which types of data that the source account shares with the monitoring account.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceTypes() method.

        Returns:
        An array of strings that define which types of data that the source account shares with the monitoring account.

      • hasResourceTypes

        public final boolean hasResourceTypes()
        For responses, this returns true if the service returned a value for the ResourceTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • resourceTypesAsStrings

        public final List<String> resourceTypesAsStrings()

        An array of strings that define which types of data that the source account shares with the monitoring account.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceTypes() method.

        Returns:
        An array of strings that define which types of data that the source account shares with the monitoring account.

      • sinkIdentifier

        public final String sinkIdentifier()

        The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.

        For more information about sinks, see CreateSink.

        Returns:
        The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.

        For more information about sinks, see CreateSink.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        Assigns one or more tags (key-value pairs) to the link.

        Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

        For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        Assigns one or more tags (key-value pairs) to the link.

        Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

        For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object